Skip to content

Commit 7a3e1fb

Browse files
committed
docs: V2.0说明
1 parent b851a35 commit 7a3e1fb

8 files changed

+85
-78
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
.vscode
2-
.DS_Store
2+
.DS_Store
3+
node_modules

README.md

Lines changed: 52 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,44 +8,78 @@
88

99
| :mega: :mega: :mega: |
1010
| :----: |
11-
| X-Developer 现已发布整体的解决方案服务体系,基于度量工具帮助组织全方位提升研发效能|
11+
| X-Developer V2.0 已正式发布:T 型数据架构、多源数据集成、开发者绩效分析,$X^d$ 行业指数,致力为您提供更好的数据洞察平台|
1212

13-
> 研发效能度量与优化解决方案 :rocket::rocket::rocket:
13+
> 研发数据管理与效能洞察平台 :rocket::rocket::rocket:
1414
15-
X-Developer 基于 **“从开发到部署”** 全过程,为企业提供研发管理量化工具并优化代码发布速度与频率。现已拥有 300 多家注册客户,为国内服务规模最大的研发效能度量平台。
15+
X-Developer V1.0 版本关注 **“从开发到部署”** 全过程,为企业提供“速率优先”的自动化数据分析工具,自2019年5月上线以来,已拥有 500 多位注册用户,近百家企业用户,为国内服务规模最大的研发效能度量平台。
1616

17-
利用 X-Developer SaaS 平台,无须任何开发工作,即可快速、实时地完成研发度量与效率分析,并实现高效的远程管理
17+
2021年7月,我们基于市场客户需求,正式发布了 X-Developer V2.0 版本
1818

19-
## 如何使用
19+
## V2.0 新特性
2020

21-
X-Developer 提供 SaaS 及私有部署两种使用模式。SaaS 模式下您只需要注册帐号、完成购买,即可开始使用在线的度量分析服务。
21+
### 新数据架构
22+
23+
基于“时间跟踪(Time Tracking)”和“深度洞察(Deep Insights)”理念设计了全新的数据架构,并基于新架构对数据挖掘框架进行了全面重构,为研发效能度量建立起了一个稳定可扩展的设计范式。
24+
25+
### 多源数据集成
26+
27+
新增了 Jira、SonarQube、Tempo Timesheet 数据集成,满足企业对需求管理、代码质量和工时管理的数据分析要求。
28+
29+
- 易使用:用户仅需在 X-Developer 平台上进行简单的应用程序配置,即可将三方数据源整合到 X-Developer 分析项目中。
30+
31+
- 可加工:通过 X-Developer 平台,还可以对三方数据进行管理,包括状态映射、缺陷标注,以及静态分析结果筛选。
32+
33+
### 配置化的开发者绩效分析
34+
35+
基于 11 组绩效指标,从日常纪律、效率、质量、贡献多个维度设计开发者绩效,自动化计算打分排名。
36+
37+
指标和分数均可通过模板进行分配,帮助技术管理者灵活制定考核办法。
38+
39+
### $X^d$ 行业指数
40+
41+
基于平台数据,我们首批推出了交付周期时间、任务流畅度、提交活跃度、加班指数、深夜加班指数、BUGS & FIX 指数六大指标,供您进行对比。
42+
43+
### 分析引擎升级
44+
45+
支持海量仓库和复杂触发时间规则,如定时执行、提交触发执行、强制分析、错锋分析等,X-Developer 提供了可配置的分析规则,帮助企业更好地利用CI/CD工具资源。
46+
47+
---
48+
49+
## 如何使用 X-Developer 平台和服务
50+
51+
X-Developer 提供 SaaS 服务、私有部署两种使用模式,并且响应客户的定制化开发要求。
52+
53+
在 SaaS 模式下,您只需要注册帐号、完成购买,即可开始使用在线的度量分析服务。
2254

2355
如果您申请的是私有部署,我们会为您提供包含部署、安装、内部培训等支持服务。
2456

25-
### 使用 SaaS 服务
57+
### 企业试用
58+
59+
X-Developer 仅为签订《产品试用协议》的企业提供试用服务。如果您有兴趣或比选采购意向,可在 [申请企业试用](https://x-developer.cn/request) 进行申请,我们会在两个工作日内与您商谈。
60+
61+
> X-Developer 是商业产品,并且价格亲民,所以我们不为个人用户提供试用。
62+
63+
### 购买 SaaS 服务
2664

27-
X-Developer 采用预付费模式,订购成功之后,以下两个计时期间我们不会向您收取任何费用:
65+
X-Developer SaaS 服务采用预付费模式,订购成功之后,以下两个计时期间我们不会向您收取任何费用:
2866

2967
- 接入期间:直至您成功接入 X-Developer 至生成数据报表的期间,您的预付费用不会产生任何的变动。在此期间,您可以与我们预约演示、获得技术支持与帮助。
3068
- 调整期间:完成接入并生成报表后,您仍有 7 天的免费期限用于对数据进行一些调整。例如,您可以选择一个小范围的团队进行试运行,对一些重名的开发者(他们可能被多计费)进行名称合并等,并对这些项目进行删除或重建,以使数据分析的价值最大化。
3169

3270
在 7 天的调整期间之后,我们会视为正式运行期,在每月底将对您的帐户进行费用扣除。
3371

34-
如果您打算使用 SaaS 版本,下一步请阅读 [快速上手](guide)
72+
### 购买私有部署版本
3573

36-
### 申请私有部署版本
74+
购买之前如有试用需求,我们将先与您签订试用合同,并提供 2 个 SaaS 试用许可证和约定的试用期限供您内部测试。
3775

38-
如果您需要 X-Developer 的私有部署版本,请在 [版本和报价页面](https://x-developer.cn/pricing) 申请。我们会为您安排产品演示,如果 X-Developer 适合您的企业需求,我们将提供 2 个试用许可证和 14 天试用期限,以供您创建 2 个团队进行数据测试
76+
产品采购之后,将按照正式的《产品技术服务合同》履行相关的权利责任
3977

40-
## 进阶功能
78+
### 定制化开发
4179

42-
X-Developer提供了 CI/CD 集成以实现实时自动化的度量分析,已支持的主流 CI/CD 工具及集成指南如下:
80+
X-Developer 支持在基础版和专业版之上进行定制开发,并可基于 SaaS 或私有部署进行交付,其中 SaaS 交付模式仅收取适当的费用。
4381

44-
- [GitHub](intergration/github.md):最强大的在线代码托管平台
45-
- [GitLab](intergration/gitlab.md):绝大多数企业自建私有代码托管平台的首选
46-
- [Coding](intergration/coding.md):国产在线代码托管平台,提供私有部署
47-
- [TravisCI](intergration/travis.md):主流的持续集成云平台
48-
- [Jenkins](intergration/jenkins.md):主流的持续集成开源工具
82+
正常情况下,我们会在 30 天内响应完成您的定制化需求,如果是较大的功能需求,我们会进一步与您商讨交付时间点和细节。
4983

5084
## 需要支持
5185

_media/discovery-processing.png

33.7 KB
Loading

_media/discovery-success.png

27.8 KB
Loading

_media/discovery-team.png

34 KB
Loading

_media/discovery-upload.png

74.3 KB
Loading

guide.md

Lines changed: 17 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,39 @@
11
# 快速上手
22

3-
> X-Developer 是构建在 DevOps 之上的研发效能度量工具,与代码提交流程无缝结合,实现无须人工干预的真实数据效率分析。
4-
5-
## 工作流程
6-
7-
如下图所示,创建团队后可选择手动在线分析或 API 集成 CI/CD 工具自动化效能分析,最终生成度量报告。
8-
9-
```mermaid
10-
graph LR
11-
team([创建团队]) --> API[[API]]
12-
team --手动选项--> online([在线分析])
13-
online --> upload([上传日志])
14-
upload --> run([运行])
15-
run --> analysis
16-
subgraph 自动化过程
17-
API --> GitHub([GitHub])
18-
API --> GitLab([GitLab])
19-
API --> Coding([Coding.net])
20-
API --> Travis([TravisCI])
21-
API --> Jenkins([Jenkins])
22-
GitHub --Action--> auth((鉴权))
23-
GitLab --job--> auth
24-
Coding --job--> auth
25-
Travis --job--> auth
26-
Jenkins --Plugin--> auth
27-
auth --> analysis((分析))
28-
analysis --> reports(报告)
29-
style reports fill:#f9f,stroke:#333,stroke-width:4px
30-
end
31-
```
32-
33-
## 创建团队
34-
35-
如果您是首次使用 X-Developer ,工作台默认会出现创建团队的提示。
3+
> X-Developer 是研发全生命周期的数据管理与效能洞察平台,我们基于在自动化和研发效能领域的技术能力与经验,完全自主创新、自主研发了 X-Developer 平台,致力为您提供理念领先行业、技术自主可控的新一代研发数据分析工具。
364
37-
![](_media/create-team.png)
5+
## X-Developer 是什么?
386

39-
完成团队创建后,将进入空白的团队界面,并提示您运行分析
7+
X-Developer 是数据类产品,向 GIT 仓库及其它三方研发工具(如 Jira、SonarQube、Tempo Timesheet 等)自动化地完成数据采集,通过我们自主研发的效能分析引擎,X-Developer 最终为您生成研发管理、项目管理、工程管理、质量管理等多维度的指标和分析报表
408

41-
![](_media/wait-analysis.png)
9+
## 产品体验流程
4210

43-
## 手动分析
11+
X-Developer 提供了“免费诊断”帮助您获得第一份研发效能分析报告,无论注册用户还是访客,均可以使用免费诊断功能。
4412

45-
!> 适用于基础版用户
13+
如果您是首次使用 X-Developer ,请确保您会操作 Git 命令行以生成一份日志,以用于执行数据分析
4614

47-
手动分析模式下,需要您自行生成 Git 日志。进入待分析的 Git 仓库,运行 Git 日志生成的命令如下:
15+
进入待分析的 Git 仓库,运行 Git 日志生成的命令如下:
4816

4917
```bash
5018
git log --pretty=format:"%an,%ae,%ad,%s" >> commits.csv
5119
```
5220

53-
选择“手动分析”,在弹出界面中选择您生成的日志 `commits.csv` ,再点击“查看报告”。
54-
55-
![](_media/online-analysis.png)
56-
57-
如果您的日志是从 `master` 导出,请勾选“Git仓库主干日志”,运行“查看报告”。
58-
59-
![](_media/online-analysising.png)
21+
进入 [免费诊断](https://x-developer.cn/discovery/) 将您生成的日志 `commits.csv` 拖入文件区域,分析将自动启动。
6022

61-
## 自动化分析
23+
![](_media/discovery-upload.png)
6224

63-
!> 适用于专业版及企业版用户
25+
根据日志文件的大小,您需要等待一至五分钟
6426

65-
X-Developer 提供了对 GitHub、GitLab、Coding.net、TravisCI 以及 Jenkins 等主流工具的集成。选择您使用的工具,参照以下文档配置接入:
27+
![](_media/discovery-processing.png)
6628

67-
- [GitHub](intergration/github.md):最强大的在线代码托管平台
68-
- [GitLab](intergration/gitlab.md):绝大多数企业自建私有代码托管平台的首选
69-
- [Coding](intergration/coding.md):国产在线代码托管平台,提供私有部署
70-
- [TravisCI](intergration/travis.md):主流的持续集成云平台
71-
- [Jenkins](intergration/jenkins.md):主流的持续集成开源工具
29+
分析完成后将看到查看按钮。
7230

73-
工具接入所需的身份验证及团队信息可在 [API](https://x-developer.cn/accounts/api) 页面查看。
31+
![](_media/discovery-success.png)
7432

75-
如果您使用的工具未在此列,请在平台上提交反馈,或直接联系我们:[[email protected]](mailto:[email protected])
33+
## 团队洞察报告
7634

77-
## 查看报告
35+
在这份报告中,X-Developer 向您展示了团队相关的指标和行业对比。
7836

79-
X-Developer 分析完成后,您将进入“概览”界面,向您呈现了项目的近期进展。
37+
![](_media/discovery-team.png)
8038

81-
![](_media/reports-progress.png)
39+
> 这只是免费体验的beta版本,我们会不断推出更多的免费体验报告指标。

updates.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
## 当前版本
44

5+
### V2.0 正式发布
6+
7+
2021.7.11 大版本升级
8+
9+
- 新数据架构
10+
- 新指标体系及数据仪表板
11+
- 时间跟踪数据看板
12+
- 交付洞察数据看板
13+
- 绩效指标体系及配置模板
14+
- 开发者绩效分析
15+
- 工时统计分析
16+
- 重要指标行业对比
17+
- $X^d$行业指数
18+
519
#### V1.4 正式版发布
620

721
2020.8.22 网站改版及性能优化

0 commit comments

Comments
 (0)