docs: support multi-project delivery units (#13)
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: 710503a62b7a4ebd3c9d7a1a08dbd398161595d0
|
||||
synchronized_at: 2026-08-10T06:23:35Z
|
||||
wiki_revision: a443c206780ecd40ae45732ca10686427f393349
|
||||
synchronized_at: 2026-08-10T11:03:03Z
|
||||
<!-- gitea-wiki-mirror:end -->
|
||||
|
||||
# 新项目文档初始化
|
||||
@@ -26,11 +26,25 @@ synchronized_at: 2026-08-10T06:23:35Z
|
||||
|
||||
把项目专用红线写入根目录或子目录 `AGENTS.md`。
|
||||
|
||||
### 2. 建立 Gitea
|
||||
### 2. 识别子项目与交付单元
|
||||
|
||||
先判断仓库中有几个应用、服务、客户端、库或其他可独立交付的部分。对每个部分确认:
|
||||
|
||||
- 职责和目录边界;
|
||||
- 技术栈、依赖和支持环境;
|
||||
- 构建、测试和运行命令;
|
||||
- 是否拥有独立版本号和发布方式;
|
||||
- 适用的根目录或子目录 `AGENTS.md`;
|
||||
- 与其他子项目共享的接口、数据或业务流程;
|
||||
- 共享契约的唯一事实来源和兼容要求。
|
||||
|
||||
把结果写入 Project-Profile 的“子项目与交付单元”。单应用项目只填写一个交付单元;多应用单仓库为规则不同的目录增加子目录 `AGENTS.md`,但不因为技术栈不同自动拆仓,也不强制统一版本和发布周期。
|
||||
|
||||
### 3. 建立 Gitea
|
||||
|
||||
创建远端仓库并完成允许的初始引导提交。开启工单和 Wiki。任何产品功能开发在引导提交后都必须先有单元任务工单。
|
||||
|
||||
### 3. 修改镜像配置
|
||||
### 4. 修改镜像配置
|
||||
|
||||
把 `wiki-docs.json` 中的地址、owner 和 repository 改成新项目;核心主题映射保留。
|
||||
|
||||
@@ -38,7 +52,7 @@ synchronized_at: 2026-08-10T06:23:35Z
|
||||
|
||||
不要把 PAT 写入配置。
|
||||
|
||||
### 4. Agent 检查项目事实
|
||||
### 5. Agent 检查项目事实
|
||||
|
||||
Agent 只读检查:
|
||||
|
||||
@@ -51,7 +65,7 @@ Agent 只读检查:
|
||||
|
||||
区分“代码中确认的事实”“负责人确认的业务规则”和“仍待确认的假设”。
|
||||
|
||||
### 5. 确定交付对象和文档
|
||||
### 6. 确定交付对象和文档
|
||||
|
||||
由项目负责人确认哪些岗位或客户会实际使用、部署、管理、支持、集成或验收产品,并为每类对象确定:
|
||||
|
||||
@@ -63,7 +77,7 @@ Agent 只读检查:
|
||||
|
||||
按照[交付文档指南](Delivery-Documentation-Guide.-)选择文档,使用[岗位文档模板](Audience-Document-Template.-)按需创建。没有明确读者的文档不创建,不预建空白的用户手册、管理员手册或运维手册。
|
||||
|
||||
### 6. 先创建线上 Wiki
|
||||
### 7. 先创建线上 Wiki
|
||||
|
||||
至少创建或填写:
|
||||
|
||||
@@ -81,7 +95,7 @@ Agent 只读检查:
|
||||
|
||||
Home 给出建议阅读顺序;每个命令必须有预期结果;代码地图必须指出入口和测试位置。具体岗位文档仅按第 5 步确认的受众创建。
|
||||
|
||||
### 7. 人工确认
|
||||
### 8. 人工确认
|
||||
|
||||
项目负责人至少确认:
|
||||
|
||||
@@ -92,7 +106,7 @@ Home 给出建议阅读顺序;每个命令必须有预期结果;代码地图
|
||||
- 哪些修改属于高风险;
|
||||
- 交付对象、文档可见范围和外部信息边界。
|
||||
|
||||
### 8. 导出镜像并检查
|
||||
### 9. 导出镜像并检查
|
||||
|
||||
```powershell
|
||||
python dev_scripts/sync_wiki_docs.py
|
||||
@@ -112,6 +126,8 @@ python -m unittest discover -s tests -v
|
||||
- 常用功能从哪个目录和入口开始读;
|
||||
- 一个简单修改通常要改哪里、验证什么;
|
||||
- 哪些情况必须停止并交给 Agent 或负责人;
|
||||
- 项目包含哪些子项目和独立交付单元,各自怎样构建、测试和发布;
|
||||
- 跨子项目共享什么接口或契约,其唯一事实来源在哪里;
|
||||
- 项目需要向哪些岗位交付什么文档,以及哪些内容不能对外提供。
|
||||
|
||||
回答不了的问题应继续补充主题文档,而不是堆入任务归档。
|
||||
|
||||
Reference in New Issue
Block a user