docs: split docs readmes into topic files

This commit is contained in:
tradecatlabs
2026-06-01 00:48:27 +08:00
parent 93d9507a27
commit dddb9cd19b
54 changed files with 12565 additions and 13215 deletions
+3 -2
View File
@@ -8,7 +8,8 @@
```text
workflow/
├── README.md # 线性总文档:开发流程集合
├── README.md # 索引入口:开发流程导航
├── development-process.md
└── AGENTS.md # 本目录操作规则
```
@@ -16,7 +17,7 @@ workflow/
- 继承 `docs/AGENTS.md` 的 README 结构契约:H1 后直接进入 `## 字多不看`,再按 `快速导航 -> 完整细粒度目录 -> 使用方式 -> 正文` 排列。
- 本目录只放流程类文档,不放一次性任务记录、日志、源码快照或私密配置。
- 新增流程时优先追加到 `README.md`,不新增同级主题 `.md` 文件
- 新增流程时写入独立流程文档,并同步更新 `README.md` 索引
- 新增流程必须能被执行、检查和复用,避免只写抽象口号。
- 涉及命令、路径、配置、CI、Git 操作时,必须与仓库当前事实一致。
- 不在本目录保存密钥、Token、本地账号、真实私有项目配置或一次性日志。
+8 -29
View File
@@ -3,50 +3,29 @@
## 字多不看
- 本目录收敛项目开发流程,回答“从接到任务到提交推送应该怎么做”。
- 默认流程是明确目标、读取上下文、制定计划、执行修改、运行门禁、检查差异、控制版本、推送远端、同步文档。
- 涉及目录、命令、配置、质量门禁或版本控制变化时,必须同步更新对应 README / AGENTS / 索引。
- 默认流程是明确目标、读取上下文、制定计划、执行修改、运行门禁、检查差异、控制版本、推送远端、同步文档。
- 流程要能执行、检查和复用,不写只适合一次性任务的日志。
## 快速导航
1. [开发流程](#workflow-development-process) - 项目默认开发顺序、检查节点和交付闭环。
| 文档 | 定位 |
|:---|:---|
| <a id="workflow-development-process"></a>[开发流程](development-process.md) | 默认任务推进顺序、质量门禁和交付闭环。 |
<details>
<summary><strong>完整细粒度目录(点击展开/收起)</strong></summary>
### 细粒度目录
- [1. 开发流程](#workflow-development-process)
- [开发流程](development-process.md) - 默认任务推进顺序、质量门禁和交付闭环。
</details>
## 使用方式
- 开始任务前,先按本文档确认任务顺序和验收节点。
- 需要执行 Git、提交或推送时,同时遵循根目录 `AGENTS.md` 中的版本控制规则。
- 修改流程内容后,运行 `make sync-doc-toc``make test`
- 开始任务前,先按开发流程确认任务顺序和验收节点。
- 需要执行 Git、提交或推送时,同时遵循根目录 AGENTS.md 中的版本控制规则。
## 正文
---
<details>
<summary><strong>1. 开发流程</strong> - 默认任务推进顺序、质量门禁和交付闭环。(点击展开/收起)</summary>
<a id="workflow-development-process"></a>
## 1. 开发流程
默认开发流程:
1. 明确目标:写清楚要做什么、不要做什么、成功标准是什么。
2. 读取上下文:先看 README、AGENTS、相关目录说明和现有实现。
3. 制定计划:把任务拆成可验证的小步骤,必要时先给用户确认。
4. 执行修改:按最小影响面修改文件,不顺手重构无关内容。
5. 运行门禁:至少运行 `make test`;涉及专项工具时补对应验证命令。
6. 检查差异:用 `git diff` 确认没有混入临时文件、敏感信息或无关改动。
7. 控制版本:使用语义清晰的 commit 记录阶段性成果。
8. 推送远端:默认推送当前 `develop` 分支,并观察 GitHub Actions 结果。
9. 同步文档:目录、命令、配置、流程变化必须同步 README / AGENTS / 对应索引。
</details>
正文已拆分到上方独立文档;本 README 只保留索引、旧锚点兼容入口和阅读顺序。
+15
View File
@@ -0,0 +1,15 @@
<a id="workflow-development-process"></a>
# 开发流程
默认开发流程:
1. 明确目标:写清楚要做什么、不要做什么、成功标准是什么。
2. 读取上下文:先看 README、AGENTS、相关目录说明和现有实现。
3. 制定计划:把任务拆成可验证的小步骤,必要时先给用户确认。
4. 执行修改:按最小影响面修改文件,不顺手重构无关内容。
5. 运行门禁:至少运行 `make test`;涉及专项工具时补对应验证命令。
6. 检查差异:用 `git diff` 确认没有混入临时文件、敏感信息或无关改动。
7. 控制版本:使用语义清晰的 commit 记录阶段性成果。
8. 推送远端:默认推送当前 `develop` 分支,并观察 GitHub Actions 结果。
9. 同步文档:目录、命令、配置、流程变化必须同步 README / AGENTS / 对应索引。