Skip to content

Commit feb0079

Browse files
Supplement the documentation development process
1 parent 5176b71 commit feb0079

File tree

4 files changed

+79
-0
lines changed

4 files changed

+79
-0
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# openvela 文档开发流程
2+
3+
![documentation_development_process](./images/doc_dev_process.svg)
4+
5+
## 一 分解需求
6+
7+
### 需求Owner
8+
9+
1. 规划功能特性需求时,判断该需求是否涉及新增或修改开发者文档。
10+
2. 如果涉及,则分解 **ISSUE** 需求给文档团队,便于文档需求跟踪闭环。
11+
12+
### 文档团队
13+
14+
1. 根据相关需求,提供文档设计意见。
15+
2. 配合各业务团队完成文档的评审、测试、翻译和发布。
16+
17+
## 二 开发文档
18+
19+
### 业务团队成员要做的
20+
21+
#### 1 开发文档
22+
23+
如果你负责开发某一特性,你需要与文档团队一起配合,确保在版本发布之前完成该特性所配套文档的开发。否则,未提供配套文档的特性在发布时可能被移除。
24+
25+
1. 联系[文档团队资料作者](doc_reviewer.md),讨论文档设计。
26+
2. 参考[文档写作模板](../template)进行配套文档的写作。
27+
3. 为功能特性撰写详细的文档初稿,提交 PR 并在描述中提供对应的需求 `Issue` 链接。
28+
29+
#### 2 提交PR评审
30+
31+
- 提交 PR 后,会自动指定技术专家和资料专家进行评审。
32+
- 技术专家审核后给出 `Approve` 的结论。
33+
- 资料专家审核后给出 `DocsApprove` 的评论。
34+
35+
#### 3 提交测试
36+
37+
- 文档随版本转测试后,文档工程师对文档进行测试。
38+
- 测试过程中发现的文档问题,以 Issue 形式提交到 Docs 仓,对应文档作者闭环确认测试意见并完成文档修改。
39+
40+
#### 4 提交翻译
41+
42+
- 建议自行翻译。
43+
- 如需文档团队翻译,请在中文文档完成评审测试定稿后提交翻译需求。提交翻译需求时请配套提供以下信息:
44+
1. 新增术语请补充至[术语表](../../overview/glossary.md)
45+
2. 英文截图。
46+
47+
### 文档团队成员要做的
48+
49+
### 1 评审文档
50+
51+
#### 内容易理解
52+
53+
- 逻辑准确,术语一致。
54+
- 步骤清晰,有效指导开发者完成相关任务开发
55+
- 图文结合,避免只有大量篇幅的文字描述。
56+
57+
#### 整体信息架构
58+
59+
- 新增 Markdown 页面时,需确保:
60+
- 该页面内容使用了正确的内容模板。
61+
62+
- 变更 Markdown 页面时,需确保:
63+
- 该页面对社区其他内容链接未产生影响,建议本地进行检查。
64+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 文档评审人
2+
3+
## 文档规范评审人
4+
5+
[@tanghao-xiaomi](https://github.com/tanghao-xiaomi)
6+
7+
## 技术准确性评审人

0 commit comments

Comments
 (0)