docs: 建立最小交付文档体系 (#11)
This commit is contained in:
@@ -2,8 +2,8 @@
|
||||
generated: true (请先修改 Gitea Wiki,禁止直接编辑本文件)
|
||||
wiki_page: New-Project-Documentation-Setup
|
||||
wiki_url: http://ilaer.eicp.net:8418/opc/dev_harness/wiki/New-Project-Documentation-Setup.-
|
||||
wiki_revision: a0eeab23a41671b5dbfc3153e872b71647ea41c7
|
||||
synchronized_at: 2026-08-08T01:16:59Z
|
||||
wiki_revision: 710503a62b7a4ebd3c9d7a1a08dbd398161595d0
|
||||
synchronized_at: 2026-08-10T06:23:35Z
|
||||
<!-- gitea-wiki-mirror:end -->
|
||||
|
||||
# 新项目文档初始化
|
||||
@@ -51,7 +51,19 @@ Agent 只读检查:
|
||||
|
||||
区分“代码中确认的事实”“负责人确认的业务规则”和“仍待确认的假设”。
|
||||
|
||||
### 5. 先创建线上 Wiki
|
||||
### 5. 确定交付对象和文档
|
||||
|
||||
由项目负责人确认哪些岗位或客户会实际使用、部署、管理、支持、集成或验收产品,并为每类对象确定:
|
||||
|
||||
- 需要完成的工作;
|
||||
- 所需文档类型;
|
||||
- 文档可见范围;
|
||||
- 适用版本、负责人和验证人;
|
||||
- 不得对外披露的内部信息。
|
||||
|
||||
按照[交付文档指南](Delivery-Documentation-Guide.-)选择文档,使用[岗位文档模板](Audience-Document-Template.-)按需创建。没有明确读者的文档不创建,不预建空白的用户手册、管理员手册或运维手册。
|
||||
|
||||
### 6. 先创建线上 Wiki
|
||||
|
||||
至少创建或填写:
|
||||
|
||||
@@ -63,11 +75,13 @@ Agent 只读检查:
|
||||
6. Common-Changes;
|
||||
7. Troubleshooting;
|
||||
8. Development-Workflow;
|
||||
9. Task-Archive-Template。
|
||||
9. Delivery-Documentation-Guide;
|
||||
10. Audience-Document-Template;
|
||||
11. Task-Archive-Template。
|
||||
|
||||
Home 给出建议阅读顺序;每个命令必须有预期结果;代码地图必须指出入口和测试位置。
|
||||
Home 给出建议阅读顺序;每个命令必须有预期结果;代码地图必须指出入口和测试位置。具体岗位文档仅按第 5 步确认的受众创建。
|
||||
|
||||
### 6. 人工确认
|
||||
### 7. 人工确认
|
||||
|
||||
项目负责人至少确认:
|
||||
|
||||
@@ -75,9 +89,10 @@ Home 给出建议阅读顺序;每个命令必须有预期结果;代码地图
|
||||
- 关键业务规则和状态;
|
||||
- 权限、安全和数据边界;
|
||||
- 真实运行、测试和部署命令;
|
||||
- 哪些修改属于高风险。
|
||||
- 哪些修改属于高风险;
|
||||
- 交付对象、文档可见范围和外部信息边界。
|
||||
|
||||
### 7. 导出镜像并检查
|
||||
### 8. 导出镜像并检查
|
||||
|
||||
```powershell
|
||||
python dev_scripts/sync_wiki_docs.py
|
||||
@@ -96,6 +111,7 @@ python -m unittest discover -s tests -v
|
||||
- 怎样启动和运行测试;
|
||||
- 常用功能从哪个目录和入口开始读;
|
||||
- 一个简单修改通常要改哪里、验证什么;
|
||||
- 哪些情况必须停止并交给 Agent 或负责人。
|
||||
- 哪些情况必须停止并交给 Agent 或负责人;
|
||||
- 项目需要向哪些岗位交付什么文档,以及哪些内容不能对外提供。
|
||||
|
||||
回答不了的问题应继续补充主题文档,而不是堆入任务归档。
|
||||
|
||||
Reference in New Issue
Block a user