docs: 更新说明

RCFans · RCFans · commit 82f67e3690bc · 2020-08-24T23:52:49.000+08:00
diff --git a/README.md b/README.md
@@ -8,42 +8,13 @@
 
 | :mega: :mega: :mega: |
 | :----: |
-| X-Developer 现已发布整体的解决方案服务体系，基于度量，帮助组织全方位提升研发效能。|
+| X-Developer 现已发布整体的解决方案服务体系，基于度量工具帮助组织全方位提升研发效能。|
 
 > 研发效能度量与优化解决方案 :rocket::rocket::rocket:
 
-X-Developer 基于 **“从开发到部署”** 全过程，为企业提供研发数据管理、量化的基础平台。现已拥有 300 多家注册客户，为国内服务规模最大的研发效能度量平台。利用我们的平台及工具，无须任何开发工作，即可快速、实时地完成研发度量与效率分析，并实现高效的远程管理。
+X-Developer 基于 **“从开发到部署”** 全过程，为企业提供研发管理量化工具并优化代码发布速度与频率。现已拥有 300 多家注册客户，为国内服务规模最大的研发效能度量平台。
 
-## 新手必读
-
-- [快速上手](guide) - 适用于零基础新手使用者，五分钟即获得一份研发效能度量报告
-- [使用权限](permission) - 进一步了解公开和私有团队的区别和角色权限划分
-- [常见问题](faq) - 收集整理了用户关心的一些疑问和解答，持续更新中 :construction:
-
-### 领导必读
-
-- [核心优势](advantage) - X-Developer 解决什么样的问题，有什么不同的优势？:sparkles:
-- [产品说明](introduction) - X-Developer 如何帮助您的组织实现目标？:rocket:
-- [应用场景](usage) - 我们整理了一些应用场景，仍在持续更新中 :construction:
-
-## 准备使用
-
-- [GIT管理规范](flow) - 正式使用我们的产品之前，请阅读和了解相关的管理规范
-- [不同组织结构的应用](structure) - 了解您的组织结构与研发效能度量的差异化关注点
-
-### 特性说明
-
-- [团队效能管理](dem/team)
-- [自动化看板](dem/kanban)
-- [代码提交工具](commits)
-
-### 集成 CI/CD 工具
-
-- [GitHub](intergration/github.md)：最强大的在线代码托管平台
-- [GitLab](intergration/gitlab.md)：绝大多数企业自建私有代码托管平台的首选
-- [Coding](intergration/coding.md)：国产在线代码托管平台，提供私有部署
-- [TravisCI](intergration/travis.md)：主流的持续集成云平台
-- [Jenkins](intergration/jenkins.md)：主流的持续集成开源工具
+利用 X-Developer SaaS 平台，无须任何开发工作，即可快速、实时地完成研发度量与效率分析，并实现高效的远程管理。
 
 ## 如何使用
 
@@ -53,26 +24,32 @@ X-Developer 提供 SaaS 及私有部署两种使用模式。SaaS 模式下您只
 
 ### 使用 SaaS 服务
 
-X-Developer 采用的是预付费——按月结算模式，一月起订。订购成功之后，以下两个计时期间我们不会向您收取任何费用：
+X-Developer 采用预付费模式，订购成功之后，以下两个计时期间我们不会向您收取任何费用：
 
 - 接入期间：直至您成功接入 X-Developer 至生成数据报表的期间，您的预付费用不会产生任何的变动。在此期间，您可以与我们预约演示、获得技术支持与帮助。
-- 调整期间：完成接入并生成数据报表后，您仍有 7 天的时间用于对数据进行一些调整，例如，您可以选择一个小范围的团队进行试运行，对一些重名的开发者（他们可能被多计费）进行名称合并等，并对这些项目进行删除、重建等，以使数据分析的价值最大化。
+- 调整期间：完成接入并生成报表后，您仍有 7 天的免费期限用于对数据进行一些调整。例如，您可以选择一个小范围的团队进行试运行，对一些重名的开发者（他们可能被多计费）进行名称合并等，并对这些项目进行删除或重建，以使数据分析的价值最大化。
 
 在 7 天的调整期间之后，我们会视为正式运行期，在每月底将对您的帐户进行费用扣除。
 
-如果您是使用于开源项目分析，可享受免费的公开项目创建权限和“基础版”功能。
-
-非开源项目的分析，无论公开项目还是私有项目，均为付费功能。X-Developer 按月自动计费（[查看定价](https://x-developer.cn/pricing)）。
+如果您打算使用 SaaS 版本，下一步请阅读 [快速上手](guide) 。
 
 ### 申请私有部署版本
 
-如果您需要 X-Developer 的私有部署版本，请在（[版本和报价页面](https://x-developer.cn/pricing)）申请。我们会为您安排产品演示，如果 X-Developer 适合您的企业需求，我们将提供 2 个试用许可证和 14 天试用期限，以供您创建 2 个私有团队进行数据测试。
+如果您需要 X-Developer 的私有部署版本，请在 [版本和报价页面](https://x-developer.cn/pricing) 申请。我们会为您安排产品演示，如果 X-Developer 适合您的企业需求，我们将提供 2 个试用许可证和 14 天试用期限，以供您创建 2 个团队进行数据测试。
+
+## 进阶功能
+
+X-Developer提供了 CI/CD 集成以实现实时自动化的度量分析，已支持的主流 CI/CD 工具及集成指南如下：
 
-您也可以选择使用公开团队进行测试，基于 X-Developer 的[角色权限管理机制](permission)，第三方**无法**访问您的数据。
+- [GitHub](intergration/github.md)：最强大的在线代码托管平台
+- [GitLab](intergration/gitlab.md)：绝大多数企业自建私有代码托管平台的首选
+- [Coding](intergration/coding.md)：国产在线代码托管平台，提供私有部署
+- [TravisCI](intergration/travis.md)：主流的持续集成云平台
+- [Jenkins](intergration/jenkins.md)：主流的持续集成开源工具
 
 ## 需要支持
 
-如果您需要任何帮助与支持，请在平台上提交反馈（即点击产品顶部工具条的反馈按钮），或直接联系我们：[support@withfield.tech](mailto:support@withfield.tech)
+如果您需要任何帮助与支持，可通过产品内部的反馈功能提交，或直接联系我们：[support@withfield.tech](mailto:support@withfield.tech)
 
 ## 版权声明
 
diff --git a/guide.md b/guide.md
@@ -1,12 +1,10 @@
 # 快速上手
 
-> X-Developer 是构建在 DevOps、CI/CD 之上的研发效能度量工具，与代码提交流程无缝结合，利用无须人工干预的真实数据进行效率分析，帮助开发团队实现更加精益高效的旅程。
+> X-Developer 是构建在 DevOps 之上的研发效能度量工具，与代码提交流程无缝结合，实现无须人工干预的真实数据效率分析。
 
-购买 X-Developer 之后，您将进入工作台页面，在这里可以看到所有已创建项目信息，以及帐户、订单、积分、发票和API菜单入口。
+## 工作流程
 
-## 使用流程
-
-我们先熟悉一下它的使用流程，如下图所示，创建团队获得 API 信息后，完成对应 CI/CD 工具接入的配置，即可开启 X-Developer 自动化效能分析。
+如下图所示，创建团队后可选择手动在线分析或 API 集成 CI/CD 工具自动化效能分析，最终生成度量报告。
 
 ```mermaid
 graph LR
@@ -15,29 +13,23 @@ graph LR
     online --> upload([上传日志])
     upload --> run([运行])
     run --> analysis
-    API --配置--> tools{CI/CD}
     subgraph 自动化过程
-        tools --> GitHub([GitHub])
-        tools --> GitLab([GitLab])
-        tools --> Coding([Coding.net])
-        tools --> Travis([TravisCI])
-        tools --> Jenkins([Jenkins])
-        GitHub --Action--> auth((鉴权服务))
+        API --> GitHub([GitHub])
+        API --> GitLab([GitLab])
+        API --> Coding([Coding.net])
+        API --> Travis([TravisCI])
+        API --> Jenkins([Jenkins])
+        GitHub --Action--> auth((鉴权))
         GitLab --job--> auth
         Coding --job--> auth
         Travis --job--> auth
         Jenkins --Plugin--> auth
-        auth --> analysis((分析服务))
-        analysis --> data[(指标数据)]
-        analysis --> notice(邮件通知)
-        data --> reports(报告)
+        auth --> analysis((分析))
+        analysis --> reports(报告)
         style reports fill:#f9f,stroke:#333,stroke-width:4px
-        style notice fill:#bbf,stroke:#f66,stroke-width:2px,stroke-dasharray: 5, 5
     end
 ```
 
-X-Developer 的手动分析功能，方便您利用手动生成的 Git 日志，快速进行效能分析试用。
-
 ## 创建团队
 
 如果您是首次使用 X-Developer ，工作台默认会出现创建团队的提示。
@@ -48,29 +40,11 @@ X-Developer 的手动分析功能，方便您利用手动生成的 Git 日志，
 
 ![](_media/wait-analysis.png)
 
-### 获得接入信息
-
-进入 [API](https://x-developer.cn/accounts/api) 页面，您可以查看 `APPID` `APPKEY` 及已创建团队的 `TEAMID` 。
-
-## 自动化分析
-
-当前，X-Developer 提供了对 GitHub、GitLab、Coding.net、TravisCI 以及 Jenkins 等主流工具的集成。选择您使用的工具，参照以下说明文档进行配置接入：
-
-- [GitHub](intergration/github.md)：最强大的在线代码托管平台
-- [GitLab](intergration/gitlab.md)：绝大多数企业自建私有代码托管平台的首选
-- [Coding](intergration/coding.md)：国产在线代码托管平台，提供私有部署
-- [TravisCI](intergration/travis.md)：主流的持续集成云平台
-- [Jenkins](intergration/jenkins.md)：主流的持续集成开源工具
-
-如果您使用的工具未在此列，请在平台上提交反馈，或直接联系我们：[support@withfield.tech](mailto:support@withfield.tech)
-
 ## 手动分析
 
-!> 此为可选项，适用于快速试用场景。
+!> 适用于基础版用户。
 
-如果您对 Git 工具使用非常熟练，并希望快捷地尝试 X-Developer 分析功能，可以手动生成 Git 日志并运行手动分析，五分钟左右即可查看分析报告。
-
-进入待分析的 Git 仓库，运行 Git 日志生成的命令如下：
+手动分析模式下，需要您自行生成 Git 日志。进入待分析的 Git 仓库，运行 Git 日志生成的命令如下：
 
 ```bash
 git log --pretty=format:"%an,%ae,%ad,%s" >> commits.csv
@@ -80,14 +54,28 @@ git log --pretty=format:"%an,%ae,%ad,%s" >> commits.csv
 
 ![](_media/online-analysis.png)
 
-如果您的日志是从 `master` 导出，请勾选“Git仓库主干日志”，点击“查看报告”后，X-Developer 会启动分析。
+如果您的日志是从 `master` 导出，请勾选“Git仓库主干日志”，运行“查看报告”。
 
 ![](_media/online-analysising.png)
 
+## 自动化分析
+
+!> 适用于专业版及企业版用户。
+
+X-Developer 提供了对 GitHub、GitLab、Coding.net、TravisCI 以及 Jenkins 等主流工具的集成。选择您使用的工具，参照以下文档配置接入：
+
+- [GitHub](intergration/github.md)：最强大的在线代码托管平台
+- [GitLab](intergration/gitlab.md)：绝大多数企业自建私有代码托管平台的首选
+- [Coding](intergration/coding.md)：国产在线代码托管平台，提供私有部署
+- [TravisCI](intergration/travis.md)：主流的持续集成云平台
+- [Jenkins](intergration/jenkins.md)：主流的持续集成开源工具
+
+工具接入所需的身份验证及团队信息可在 [API](https://x-developer.cn/accounts/api) 页面查看。
+
+如果您使用的工具未在此列，请在平台上提交反馈，或直接联系我们：[support@withfield.tech](mailto:support@withfield.tech)
+
 ## 查看报告
 
 X-Developer 分析完成后，您将进入“概览”界面，向您呈现了项目的近期进展。
 
 ![](_media/reports-progress.png)
-
-接下来您可以了解我们产品的 [核心优势](advantage) ，或 [常见问题](faq) 。
diff --git a/index.html b/index.html
@@ -11,15 +11,15 @@
   <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
   <script src="//unpkg.com/mermaid@8.5.1/dist/mermaid.min.js"></script>
   <script>
-    if (document.location.host.indexOf("localhost") <= -1) {
-      var _hmt = _hmt || [];
-      (function () {
-        var hm = document.createElement("script");
-        hm.src = "https://hm.baidu.com/hm.js?a80f6a4e424165733ee8c6f8cc5d688a";
-        var s = document.getElementsByTagName("script")[0];
-        s.parentNode.insertBefore(hm, s);
-      })();
-    }
+    // if (document.location.host.indexOf("localhost") <= -1) {
+    //   var _hmt = _hmt || [];
+    //   (function () {
+    //     var hm = document.createElement("script");
+    //     hm.src = "https://hm.baidu.com/hm.js?a80f6a4e424165733ee8c6f8cc5d688a";
+    //     var s = document.getElementsByTagName("script")[0];
+    //     s.parentNode.insertBefore(hm, s);
+    //   })();
+    // }
   </script>
 </head>
 
diff --git a/permission.md b/permission.md
@@ -1,75 +1,18 @@
 # 使用权限
 
-X-Developer 的分析项目（以下简称团队）分为**公开**和**私有**两类，其中公开团队可以免费创建，目前不限数量。私有团队仅针对付费用户，按购买的许可证数量（[查看定价](https://x-developer.cn/pricing)）获得创建团队的数量和权益，一个许可证能够创建一个私有团队。
+X-Developer 按购买版本的许可证数量获得创建团队的数量，一个许可证能够创建一个团队，每个团队内部可配置成员角色，并开启对应的报告查看权限。
 
-公开和私有团队并不与个人、社区或企业对应，因为企业也有许多的开源项目。
+## 角色权限配置
 
-!> 建议：按照源代码的公开程度来确定公开还是私有。
-
-如果您的项目代码是开源，建议直接使用公开团队进行分析。
-
-如果您正在孵化一个希望打算未来开源的企业内部项目，可以创建为公开团队，X-Developer 的权限模式**只允许内部的开发成员**访问公开项目。
-
-> 使用 X-Developer 进行项目度量的一大好处是，我们的测量标准也是大部分开源项目的规范。在将您的源代码开放给社区之前，确保您的各类规范满足得了社区的品味（参考：[Jenkins Style Guides](https://www.jenkins.io/doc/developer/publishing/style-guides/)）。
-
-如果您不希望第三方查看到任何有关您的团队的信息，建议创建为私有团队。
-
-## 公开团队
-
-创建公开团队之后，您将获得数据分析的**不限次的**所有使用权限，包括手动的在线分析和自动的 CI/CD 工具配置和触发分析。
-
-公开团队在数据分析完成后，会被展示到 X-Developer 的 [公开团队](https://x-developer.cn/projects/) 区域，所有的访客（包括匿名访客）都能查看到项目的卡片信息，如下所示：
-
-![](_media/team.jpg)
-
-如果您希望查看公开项目的内部数据，您需要先成为注册用户，再确认在团队中的开发者身份。
-
-### 默认访问权限
-
-默认情况下（即创建者没有进行任何的成员角色权限配置），公开团队仅有创建者能够访问内部数据，其它用户访问会看到“没有权限”的错误页。
-
-![](_media/team-permission-denied.jpg)
-
-### 开发者访问权限
-
-无论是免费还是付费用户创建的公开团队，均对该团队中关联的 Git 仓库开发者开放访问权限，并不受创建者的审核或约束。
-
-> 只要您是此团队的代码贡献者，就能够申请访问并获得自己的度量数据。
-
-#### 申请访问权限步骤
-
-1. 点击进入一个公开团队，在权限提示页面（如上图所示）点击“我是开发者”；
-2. 在团队成员验证页面上，输入您用于 Git 提交代码时配置的邮箱，点击“验证并加入团队”；
-
-![](_media/team-developer-apply.jpg)
-
-3. 如果验证不通过，您将会看到“未找到此邮箱的开发人员信息”的错误提示；
-
-![](_media/team-developer-not-found.jpg)
-
-4. 如果验证通过，您将收到权限开通的邮件。
-
-![](_media/team-developer-validation.jpg)
-
-5. 在邮件中点击“确认加入”即可关联帐号，并进入团队主页。
-
-![](_media/team-developer-email.jpg)
-
-## 私有团队
-
-私有团队除创建者及指定成员外，对所有用户均不可见。团队成员必须通过管理员授权开通，在 X-Developer 的工作台访问自己的团队。
-
-### 成员角色权限配置
-
-目前仅有项目创建者和管理员能够配置私有团队的成员角色权限。进入团队之后，在页面头部的右侧功能图标区域，点击最后一个图标“成员管理”，即进入配置页面。
+项目创建者和配置管理员能够配置团队的成员角色权限。进入团队之后，在页面头部的右侧功能图标区域，点击最后一个图标“成员管理”，即进入配置页面。
 
 ![](_media/team-config.jpg)
 
 在配置页面，您可以添加管理员、产品经理、团队管理者及开发人员，并为他们开设帐号。
 
 帐号开设成功后，对方将收到一封“权限变动”通知邮件，登录即可在“工作台”上看到新增的团队卡片，并查看对应的数据页面。
 
-### 角色权限列表
+## 角色权限列表
 
 角色 | 访问权限 | 说明
 :--- | :---- | :-----
@@ -78,6 +21,6 @@ X-Developer 的分析项目（以下简称团队）分为**公开**和**私有**
 产品经理 | 概览、看板、项目统计 | 主要查看需求及项目类统计数据
 开发者 | 概览、开发者（个人效能数据）、看板、效能趋势、项目统计、改进目标 | 不能查看其它人数据
 
-### 角色权限的移除
+## 角色权限的移除
 
-管理员可以通过在角色列表中删除成员来移除权限。移除后，对方将收到通知，并无法再看到团队卡片，也无法访问团队任何的内部数据。
+通过在角色列表中删除成员来移除权限。移除后，对方将收到通知，并无法再看到团队卡片，也无法访问团队任何的内部数据。
