docs: move workflow under docs

This commit is contained in:
tukuaiai
2026-05-05 06:03:48 +08:00
parent 3b428c6637
commit e1e895534b
12 changed files with 122 additions and 53 deletions
+4 -1
View File
@@ -14,7 +14,8 @@ docs/
├── concepts/ # 线性总文档:核心概念、问题求解与工程思想
├── philosophy/ # 线性总文档:哲学方法论、思维模型与底层认知模型
├── research/ # 线性总文档:新技术、优秀 repo、工程范式和工具趋势研究
── references/ # 线性总文档:工程实践、技术栈、清单与质量门禁
── references/ # 线性总文档:工程实践、技术栈、清单与质量门禁
└── workflow/ # 线性总文档:开发流程、质量门禁、版本控制和文档同步
```
## 关键入口
@@ -31,6 +32,8 @@ docs/
- `references/AGENTS.md`:参考资料目录操作规则。
- `research/README.md`:线性总文档,包含新技术、优秀 repo、工程范式和工具趋势研究笔记。
- `research/AGENTS.md`:研究笔记目录操作规则。
- `workflow/README.md`:线性总文档,包含默认开发流程、质量门禁和交付闭环。
- `workflow/AGENTS.md`:开发流程目录操作规则。
## 操作规范
+12 -2
View File
@@ -7,6 +7,7 @@
- 想补思维模型和方法论,读 `philosophy/`
- 想查工程模板、质量门禁、技术栈和常见坑,读 `references/`
- 想记录新技术、优秀 repo 或工程趋势,读 `research/`
- 想按标准流程推进任务、提交和推送,读 `workflow/`
## 快速导航
@@ -17,6 +18,7 @@
| [philosophy](./philosophy/) | 哲学方法论、思维模型与底层认知模型 | [哲学方法论工具箱](philosophy/README.md#philosophy-methodology-toolbox-怎么选) |
| [references](./references/) | 工程实践、技术栈、模板和检查清单 | [参考资料索引](./references/README.md#目录定位) |
| [research](./research/) | 新技术、优秀 repo 与工程范式研究 | [研究笔记索引](./research/README.md) |
| [workflow](./workflow/) | 开发流程、质量门禁和交付闭环 | [开发流程](./workflow/README.md#workflow-development-process) |
<details>
<summary><strong>完整细粒度目录(点击展开/收起)</strong></summary>
@@ -61,6 +63,12 @@
- [AGENTS](./research/AGENTS.md) - 研究笔记目录操作规则。
- [Harness 工程解析](research/README.md#research-harness-engineering) - Harness Engineering 的工程控制、评估器与反馈闭环解析。
### workflow
- [README](./workflow/README.md) - 开发流程索引。
- [AGENTS](./workflow/AGENTS.md) - 开发流程目录操作规则。
- [开发流程](workflow/README.md#workflow-development-process) - 默认任务推进顺序、质量门禁和交付闭环。
</details>
## 使用方式
@@ -68,6 +76,7 @@
- 只想快速开始:从 [getting-started](./getting-started/README.md) 进入。
- 已经有项目问题:先读 [问题求解](concepts/README.md#concept-problem-solving),再读 [工程实践](references/README.md#reference-engineering-practice)。
- 需要给 AI Agent 上下文:先给它 [AGENTS](./AGENTS.md),再给它当前任务对应目录的 README。
- 需要规范执行顺序:读 [开发流程](workflow/README.md#workflow-development-process)。
- 新增内容时,先判断它属于教程、概念、哲学、参考还是研究,再放入对应目录。
## 正文
@@ -102,5 +111,6 @@
2. [docs 目录 AGENTS](./AGENTS.md)
3. [从零开始完整入门](./getting-started/README.md#learning-map)
4. [Vibe Coding 经验](./getting-started/README.md#vibe-coding-experience)
5. [工程实践](references/README.md#reference-engineering-practice)
6. [AI 引用语料](../assets/ai-citation/README.md)
5. [开发流程](workflow/README.md#workflow-development-process)
6. [工程实践](references/README.md#reference-engineering-practice)
7. [AI 引用语料](../assets/ai-citation/README.md)
+31
View File
@@ -0,0 +1,31 @@
# workflow Agent 指南
## 目录职责
`docs/workflow/` 存放项目开发流程类 Markdown,是开发顺序、质量门禁、版本控制和文档同步规则的流程入口。
## 文件地图
```text
workflow/
├── README.md # 线性总文档:开发流程集合
└── AGENTS.md # 本目录操作规则
```
## 修改规则
- 继承 `docs/AGENTS.md` 的 README 结构契约:H1 后直接进入 `## 字多不看`,再按 `快速导航 -> 完整细粒度目录 -> 使用方式 -> 正文` 排列。
- 本目录只放流程类文档,不放一次性任务记录、日志、源码快照或私密配置。
- 新增流程时优先追加到 `README.md`,不新增同级主题 `.md` 文件。
- 新增流程必须能被执行、检查和复用,避免只写抽象口号。
- 涉及命令、路径、配置、CI、Git 操作时,必须与仓库当前事实一致。
- 不在本目录保存密钥、Token、本地账号、真实私有项目配置或一次性日志。
- 架构、目录、命令或质量门禁发生变化时,同步更新本目录和根 `README.md` / `AGENTS.md`
- 不在 README 正文中写 `和其他目录的边界``维护规则`;维护者规则只写本文件。
- 不确定项标注 TODO,并说明需要哪个文件或命令输出才能确认。
## 验证
```bash
make test
```
+52
View File
@@ -0,0 +1,52 @@
# workflow
## 字多不看
- 本目录收敛项目开发流程,回答“从接到任务到提交推送应该怎么做”。
- 默认流程是:明确目标、读取上下文、制定计划、执行修改、运行门禁、检查差异、控制版本、推送远端、同步文档。
- 涉及目录、命令、配置、质量门禁或版本控制变化时,必须同步更新对应 README / AGENTS / 索引。
- 流程要能执行、检查和复用,不写只适合一次性任务的日志。
## 快速导航
1. [开发流程](#workflow-development-process) - 项目默认开发顺序、检查节点和交付闭环。
<details>
<summary><strong>完整细粒度目录(点击展开/收起)</strong></summary>
### 细粒度目录
- [1. 开发流程](#workflow-development-process)
</details>
## 使用方式
- 开始任务前,先按本文档确认任务顺序和验收节点。
- 需要执行 Git、提交或推送时,同时遵循根目录 `AGENTS.md` 中的版本控制规则。
- 修改流程内容后,运行 `make sync-doc-toc``make test`
## 正文
---
<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>