docs: 说明更新

Author: RCFans

README.md

@@ -2,88 +2,61 @@
 
 # X-Developer 文档
 
-研发效能度量与优化的领域知识、资源和工具使用说明
+研发数据管理与效能洞察平台 :rocket::rocket::rocket: 使用说明
 
 </div>
 
-| :mega: :mega: :mega: |
-| :----: |
-| X-Developer V2.0 已正式发布：T 型数据架构、多源数据集成、开发者绩效分析，$X^d$ 行业指数，致力为您提供更好的数据洞察平台。|
+> X-Developer V1.0 版本关注 **从开发到部署** 全过程，为企业提供 **速率优先的效能数据自动化分析工具**。<br>
+> 2019年5月上线以来，X-Developer 已拥有 500 多位注册用户，其中包括近百家企业，成为国内服务规模最大的研发效能数据平台。<br>
+> 2021年7月，我们基于市场需求，正式发布了 **X-Developer V2.0 版本**，包括 T 型数据架构、多源数据集成、开发者绩效分析，$X^d$ 行业指数等全新特性，帮助客户更好地利用数据，提升内部研发管理能力。
 
-> 研发数据管理与效能洞察平台 :rocket::rocket::rocket:
+## 2.0 新特性
 
-X-Developer V1.0 版本关注 **“从开发到部署”** 全过程，为企业提供“速率优先”的自动化数据分析工具，自2019年5月上线以来，已拥有 500 多位注册用户，近百家企业用户，为国内服务规模最大的研发效能度量平台。
+更全面的数据、更丰富的指标、更合理的架构、更个性化的功能，以及行业级对标参照。
 
-2021年7月，我们基于市场客户需求，正式发布了 X-Developer V2.0 版本。
+|<nobr>编号</nobr> |<nobr>特性</nobr> |<nobr>类别</nobr>  | <nobr>说明</nobr>|
+|:---:| :--- | :---: | :---
+|1|<nobr>开发者绩效分析<nobr>|功能|基于 11 组绩效指标，从日常纪律、效率、质量、贡献多个维度设计开发者绩效，自动化计算打分排名。<br>指标和分数均 **可通过模板进行分配**，帮助技术管理者灵活制定考核办法。|
+|2|<nobr>[$X^d$ 行业指数](https://x-developer.cn/benchmark)</nobr>|<nobr>指标<nobr>|基于平台数据，我们首批推出了交付周期时间、任务流畅度、提交活跃度、加班指数、深夜加班指数、BUGS & FIX 指数六大指标，供您进行对比。|
+|3|<nobr>[多源数据集成](https://x-developer.cn/integration/)</nobr>|<nobr>集成<nobr>|新增了 Jira、SonarQube、Tempo Timesheet 数据集成，满足企业对需求管理、代码质量和工时管理的数据分析要求。<br>**易使用：**用户仅需在 X-Developer 控制上进行简单的应用程序配置，即可将三方数据源整合到 X-Developer 分析项目中。<br>**可加工：**通过 X-Developer 平台，还可以对三方数据进行管理，包括状态映射、缺陷标注，以及静态分析结果筛选。|
+|4|<nobr>新数据架构</nobr>|<nobr>架构<nobr>|基于 **时间跟踪（Time Tracking）** 和 **深度洞察（Deep Insights）** 理念设计了全新的数据架构，并对数据挖掘框架进行了全面重构，为研发效能度量建立起了一个稳定可扩展的设计范式。|
+|5|<nobr>升级分析引擎</nobr>|<nobr>组件<nobr>|支持海量仓库和复杂触发时间规则，如定时执行、提交触发执行、强制分析、错锋分析等，X-Developer 提供了可配置的分析规则，帮助企业更好地利用CI/CD工具资源。|
 
-## V2.0 新特性
+更多功能细节请访问 [版本更新](updates) 说明页面。
 
-### 1. 新数据架构
+## 如何使用
 
-基于“时间跟踪（Time Tracking）”和“深度洞察（Deep Insights）”理念设计了全新的数据架构，并基于新架构对数据挖掘框架进行了全面重构，为研发效能度量建立起了一个稳定可扩展的设计范式。
-
-### 2. 多源数据集成
-
-新增了 Jira、SonarQube、Tempo Timesheet 数据集成，满足企业对需求管理、代码质量和工时管理的数据分析要求。
-
-**易使用：**用户仅需在 X-Developer 平台上进行简单的应用程序配置，即可将三方数据源整合到 X-Developer 分析项目中。
-
-**可加工：**通过 X-Developer 平台，还可以对三方数据进行管理，包括状态映射、缺陷标注，以及静态分析结果筛选。
-
-### 3. 配置化的开发者绩效分析
-
-基于 11 组绩效指标，从日常纪律、效率、质量、贡献多个维度设计开发者绩效，自动化计算打分排名。
-
-指标和分数均可通过模板进行分配，帮助技术管理者灵活制定考核办法。
-
-### 4. $X^d$ 行业指数
-
-基于平台数据，我们首批推出了交付周期时间、任务流畅度、提交活跃度、加班指数、深夜加班指数、BUGS & FIX 指数六大指标，供您进行对比。
-
-### 5. 分析引擎升级
-
-支持海量仓库和复杂触发时间规则，如定时执行、提交触发执行、强制分析、错锋分析等，X-Developer 提供了可配置的分析规则，帮助企业更好地利用CI/CD工具资源。
-
----
-
-## 如何使用 X-Developer 平台和服务
-
-X-Developer 提供 SaaS 服务、私有部署两种使用模式，并且响应客户的定制化开发要求。
-
-在 SaaS 模式下，您只需要注册帐号、完成购买，即可开始使用在线的度量分析服务。
-
-如果您申请的是私有部署，我们会为您提供包含部署、安装、内部培训等支持服务。
+X-Developer 提供 SaaS 服务、私有部署两种模式，支持客户定制化开发。SaaS 模式下，您只需要注册帐号、完成购买，即可开始使用度量分析服务。如果您需要私有部署，我们会为您提供包含部署、安装、内部培训等支持。
 
 ### 1. 企业试用
 
-X-Developer 仅为签订《产品试用协议》的企业提供试用服务。如果您有兴趣或比选采购意向，可在 [申请企业试用](https://x-developer.cn/request) 进行申请，我们会在两个工作日内与您商谈。
+X-Developer 仅为签订《产品试用协议》的企业提供试用。如果您有比选采购意向或内部尝试的兴趣，可在 [申请企业试用](https://x-developer.cn/request) 页面提交请求，我们会在两个工作日内与您商谈。
 
-> X-Developer 是商业产品，并且价格亲民，所以我们不为个人用户提供试用。
+!> X-Developer 是商业产品，并且价格亲民，试用仅面向企业。如果您是个人用户，有使用或学习效能分析的需求，请选择直接购买，勿通过企业试用通道申请。我们可为您开具个人或企业抬头的发票。
 
 ### 2. 购买产品
 
-如果您是个人用户，有使用或学习效能分析的需求，请选择直接购买，勿通过企业试用通道申请。我们的平台可为您开具个人或企业的发票。
-
 #### 2.1 购买 SaaS 服务
 
 X-Developer SaaS 服务采用预付费模式，订购成功之后，以下两个计时期间我们不会向您收取任何费用：
 
-- 接入期间：直至您成功接入 X-Developer 至生成数据报表的期间，您的预付费用不会产生任何的变动。在此期间，您可以与我们预约演示、获得技术支持与帮助。
-- 调整期间：完成接入并生成报表后，您仍有 7 天的免费期限用于对数据进行一些调整。例如，您可以选择一个小范围的团队进行试运行，对一些重名的开发者（他们可能被多计费）进行名称合并等，并对这些项目进行删除或重建，以使数据分析的价值最大化。
+**接入期间：**直至您成功接入 X-Developer 至生成数据报表的期间，您的预付费用不会产生任何的变动。在此期间，您可以向我们反馈使用期间的问题，获得技术支持与帮助。
+
+**调整期间：**完成接入并生成报表后，您仍有 7 天的免费期限用于对数据进行一些调整。例如，您可以选择一个小范围的团队进行试运行，对一些重名的开发者（他们可能被多计费）进行名称合并等，并对这些项目进行删除或重建，以使数据分析的价值最大化。
 
 在 7 天的调整期间之后，我们会视为正式运行期，在每月底将对您的帐户进行费用扣除。
 
 #### 2.2 购买私有部署版本
 
-购买之前如有试用需求，我们将先与您签订试用合同，并提供 2 个 SaaS 试用许可证和约定的试用期限供您内部测试。
+购买之前如有试用需求，请在 [申请企业试用](https://x-developer.cn/request) 页面提交请求，我们将先与您签订试用合同，并提供 2 个 SaaS 试用许可证和约定的试用期限供您内部测试。
 
 产品采购之后，将按照正式的《产品技术服务合同》履行相关的权利责任。
 
 ### 3. 定制化开发
 
 X-Developer 支持在基础版和专业版之上进行定制开发，并可基于 SaaS 或私有部署进行交付，其中 SaaS 交付模式仅收取适当的费用。
 
-正常情况下，我们会在 30 天内响应完成您的定制化需求，如果是较大的功能需求，我们会进一步与您商讨交付时间点和细节。
+> **30 天交付承诺：**通常情况下，我们会在 30 天内发布定制化需求，如果是较大的需求，我们会进一步与您商讨交付时间点和细节。
 
 ## 需要支持
 

_coverpage.md

@@ -1,11 +1,11 @@
 # X-Developer <small>v2.0</small>
 
-> 研发速率度量与优化工具 :rocket::rocket::rocket:
+> 研发数据管理与效能洞察平台 :rocket::rocket::rocket:
 
 - 零干预的研发数据采集
 - 适用于敏捷精益的指标
 - 管理视角的分析及报表
 - 驱动研发交付速率提升
 
 [GitHub](https://github.com/FieldTech/xdocs/)
-[开始使用](#x-developer-文档)
+[开始使用](#x-developer-文档)

faq.md

@@ -1,13 +1,23 @@
 ## 产品疑问
 
-### Git仓库日志数据是什么？X-Developer是否会泄露公司源代码？
+#### Q：实施 X-Developer 的最佳路线是什么？
+
+##### A：数字化时代，做到、做好数据驱动是每一家公司关心的问题，但要做到并不容易，做好更难。
+
+不积跬步，无以致千里。尽早开始，就是达成“做到”的第一步，利用 X-Devleloper 的报告，可以直观地反馈当前“研发数字化”的落地程度。
+
+所以无须等待“一切都准备好”，只要您真正希望推动研发管理的改进，落地更先进的工具，我们可以为您提供最长三个月的试用期，帮助您一步步走向研发数据驱动。
+
+**尝试——采纳——推广**，这是每一项创新成功生存的过程，也是您的组织在数字代朝代孕育新想法、新产品、新市场的过程，采用 X-Developer，也是作为组织的管理者，您的一次创新的旅程。
+
+#### Q：Git仓库日志数据是什么？X-Developer是否会泄露公司源代码？
 
 - X-Developer 是管理量化工具，分析过程不涉及任何源代码。
 - X-Developer 使用的日志数据仅包含开发人员姓名、邮件、提交时间和提交注释，所以不会泄露源代码。
 - X-Developer 使用日志作计算分析后，仅存储指标结果，不在服务端保存任何原始日志。
 - X-Developer 提供了敏感词库，使用者可以自行屏蔽敏感的信息如公司名称、客户名称和项目名称等。
 
-### X-Developer的工作原理是什么？如何保证分析结果的正确性？
+#### Q：X-Developer的工作原理是什么？如何保证分析结果的正确性？
 
 - 在技术实现上，X-Developer 使用时间序列分析、自然语言处理、聚类分析等在统计分析、机器学习领域经过证实并广泛运用的算法进行管理领域上的落地应用。
 - 在管理应用上，X-Developer 基于业界共识的敏捷精益思想对日志数据进行分析挖掘，建立了为满足快速迭代目标的多项关键指标的归因分析模型。

guide.md

@@ -1,24 +1,27 @@
 # 快速上手
 
-> X-Developer 是研发全生命周期的数据管理与效能洞察平台，我们基于在自动化和研发效能领域的技术能力与经验，完全自主创新、自主研发了 X-Developer 平台，致力为您提供理念领先行业、技术自主可控的新一代研发数据分析工具。
+> X-Developer 是 **研发全生命周期的数据管理与效能洞察平台**，我们基于在自动化和研发效能领域的技术能力与经验，完全自主创新、自主研发了这一平台。<br>X-Developer 致力为您提供 **理念领先行业、技术自主可控的新一代研发数据分析工具。**
 
-## X-Developer 提供什么功能？
+## 主要功能
 
-作为数据类产品，X-Developer 提供的功能是向 GIT 仓库及其它三方研发工具（如 Jira、SonarQube、Tempo Timesheet 等）自动化地完成数据采集，通过我们自主研发的效能分析引擎，X-Developer 最终为您生成研发管理、项目管理、工程管理、质量管理等多维度的指标和分析报表。
+定位于研发数据平台，X-Developer 的主要功能是：向 Git 仓库及其它三方研发工具（如 Jira、SonarQube、Tempo Timesheet 等）自动化地完成数据采集，通过我们自主研发的效能分析引擎，为您生成研发管理、项目管理、工程管理、质量管理等多维度的指标和分析报表。
 
 ![交付洞察](_media/deep-insights.png)
 
-## X-Developer 体验流程
+## 体验流程
 
-X-Developer 提供了“免费诊断”帮助您获得第一份研发效能分析报告，无论注册用户还是访客，均可以使用免费诊断功能。
+X-Developer 提供“免费诊断”帮助您获得第一份研发效能分析报告。无论注册用户还是访客，均可以使用免费诊断功能。
 
-如果您是首次使用 X-Developer ，请确保您会操作 Git 命令行以生成一份日志，以用于执行数据分析。
+!> 如果您是首次使用 X-Developer ，请确保您会操作 Git 命令行，用于生成执行数据分析的日志文件。
 
-进入待分析的 Git 仓库，运行 Git 日志生成的命令如下：
+### 第一步：生成日志
+
+进入待分析的 Git 仓库，运行如下命令：
 
 ```bash
 git log --pretty=format:"%an,%ae,%ad,%s" >> commits.csv
 ```
+### 第二步：使用日志进行分析
 
 进入 [免费诊断](https://x-developer.cn/discovery/) 将您生成的日志 `commits.csv` 拖入文件区域，分析将自动启动。
 
@@ -28,11 +31,13 @@ git log --pretty=format:"%an,%ae,%ad,%s" >> commits.csv
 
 ![](_media/discovery-processing.png)
 
-分析完成后将看到查看按钮。
+### 第三步：完成分析
+
+分析完成后将看到查看按钮，点击即可查看诊断报告。
 
 ![](_media/discovery-success.png)
 
-## 团队洞察报告
+## 诊断报告
 
 在这份报告中，X-Developer 向您展示了团队相关的指标和行业对比。
 
@@ -42,4 +47,4 @@ git log --pretty=format:"%an,%ae,%ad,%s" >> commits.csv
 
 ## 您还可以免费查看 $X^d$ 指数
 
-基于平台数据生成的 [$X^d$ 指数](https://x-developer.cn/benchmark)，首批推出了交付周期时间、任务流畅度、提交活跃度、加班指数、深夜加班指数、BUGS & FIX 指数六大指标，供您进行对比。
+V2.0 版本，我们基于平台数据生成 [$X^d$ 指数](https://x-developer.cn/benchmark)，首批推出了交付周期时间、任务流畅度、提交活跃度、加班指数、深夜加班指数、BUGS & FIX 指数六大指标，供您进行对比。

index.html

@@ -3,7 +3,7 @@
 
 <head>
   <meta charset="UTF-8">
-  <title>研发效能度量平台：X-Developer 官方文档</title>
+  <title>X-Developer 官方文档</title>
   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
   <meta name="description" content="Description">
   <meta name="viewport"

updates.md

@@ -1,20 +1,24 @@
 # 版本更新
 
-## 当前版本
+经过一年的等待，X-Developer 2.0 正式发布，为您带来了更多、更丰富的数据与功能。
 
-### V2.0 正式发布
+## 当前版本：V2.0
 
-2021.7.11 大版本升级
+|<nobr>发布时间</nobr> |<nobr>版本号</nobr> |<nobr>类别</nobr> |<nobr>关键词</br> | <nobr>发布特性清单</nobr>|
+|:---:| :---: | :---: | :--- | :---
+|2021.7.11|V2.0|大版本升级|可扩展的数据平台|<ul><li>新数据架构</li><li>新指标体系及数据仪表板</li><li>时间跟踪数据看板</li><li>交付洞察数据看板</li><li>绩效指标体系及配置模板</li><li>开发者绩效分析</li><li>工时统计分析</li><li>重要指标行业对比</li><li>$X^d$行业指数</li>
 
-- 新数据架构
-- 新指标体系及数据仪表板
-- 时间跟踪数据看板
-- 交付洞察数据看板
-- 绩效指标体系及配置模板
-- 开发者绩效分析
-- 工时统计分析
-- 重要指标行业对比
-- $X^d$行业指数
+## 发布计划
+
+> 近期我们将公布新的开发计划，敬请等待。
+
+### V1.4版本
+
+增强团队效能洞察能力，提供更多的数据应用。新增任务效能分析功能，提供基于任务的效能盘点和过程跟踪，提升组织管理任务的效率。
+
+发布日期为：2020年5月22日。
+
+## 更新日志
 
 #### V1.4 正式版发布
 
@@ -53,16 +57,6 @@
 
 !> 本月的重要发布是新的产品文档，语雀上的旧文档将**不再更新，计划5月底删除。**
 
-## 发布计划
-
-### V1.4版本
-
-增强团队效能洞察能力，提供更多的数据应用。新增任务效能分析功能，提供基于任务的效能盘点和过程跟踪，提升组织管理任务的效率。
-
-发布日期为：2020年5月22日。
-
-## 更新日志
-
 ### V1.3.2 全新的项目面板发布
 
 2020.5.7 发布了新的项目面板界面，直观地展示成员和进行任务统计。