diff --git a/docs/AGENTS.md b/docs/AGENTS.md index a19d5da..0ec1ede 100644 --- a/docs/AGENTS.md +++ b/docs/AGENTS.md @@ -47,6 +47,13 @@ docs/ - 大规模重命名/移动文件导致链接失效（如必须调整，需同步更新引用）。 - 新增目录但不补 `README.md` 和 `AGENTS.md`。 +## 维护规则 + +- 每个目录必须同时维护 `README.md` 和 `AGENTS.md`。 +- 新增、删除、移动、重命名文档时，必须同步更新 `docs/README.md`、所在目录索引和 `metadata/taxonomy.yml`。 +- 面向 AI 引用的重要入口变化，必须同步更新 `assets/ai-citation/llms-full.txt` 和相关摘要文件。 +- 不确定信息标注 TODO，不用猜测补齐。 + ## 命名规范 - 文件名使用中文或清晰英文。 diff --git a/docs/README.md b/docs/README.md index 26e44f8..7e8e8cd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -104,10 +104,3 @@ 4. [Vibe Coding 经验](./getting-started/README.md#vibe-coding-experience) 5. [工程实践](references/README.md#reference-engineering-practice) 6. [AI 引用语料](../assets/ai-citation/README.md) - -### 维护规则 - -- 每个目录必须同时维护 `README.md` 和 `AGENTS.md`。 -- 新增、删除、移动、重命名文档时，必须同步更新本索引、所在目录索引和 `metadata/taxonomy.yml`。 -- 面向 AI 引用的重要入口变化，必须同步更新 `assets/ai-citation/llms-full.txt` 和相关摘要文件。 -- 不确定信息标注 TODO，不用猜测补齐。 diff --git a/docs/concepts/README.md b/docs/concepts/README.md index 981981c..65279c2 100644 --- a/docs/concepts/README.md +++ b/docs/concepts/README.md @@ -167,27 +167,9 @@ ## 使用方式 - 先从 [问题求解](#concept-problem-solving) 建立任务定义，再进入具体工具和工程实践。 -- 如果内容是步骤、命令和环境配置，放到 [getting-started](../getting-started/README.md)。 -- 如果内容是工程清单、模板、质量门禁或技术栈，放到 [references](../references/README.md#目录定位)。 -- 如果内容是思维模型、哲学模型或底层认知框架，放到 [philosophy](../philosophy/README.md#philosophy-methodology-toolbox-怎么选)。 -- 如果内容是新技术、优秀 repo 或趋势判断，放到 [research](../research/README.md#目录定位)。 ## 正文 -### 和其他目录的边界 - -- 具体入门步骤放在 [getting-started](../getting-started/README.md)。 -- 工程模板、质量门禁、常见坑和技术栈放在 [references](../references/README.md#目录定位)。 -- 思维模型、编程哲学和底层认知模型放在 [philosophy](../philosophy/README.md#philosophy-methodology-toolbox-怎么选)。 -- 新技术、优秀 repo 和趋势判断先放在 [research](../research/README.md#目录定位)。 - -### 维护规则 - -- 本目录采用“线性总文档”结构，正文统一收敛到 `README.md`。 -- 新增内容时优先追加到对应大章节，并同步补充快速导航或完整细粒度目录。 -- 不再新增同级主题 `.md` 文件；如确需拆分，必须同步更新全仓索引、AGENTS 与 metadata。 -- 目录内只保留 `README.md` 与 `AGENTS.md`。 - ---
diff --git a/docs/philosophy/README.md b/docs/philosophy/README.md index 43cf980..482784b 100644 --- a/docs/philosophy/README.md +++ b/docs/philosophy/README.md @@ -116,7 +116,6 @@ - [4. 方法论工具箱](#philosophy-methodology-toolbox) - [目录定位](#philosophy-methodology-toolbox-目录定位) - [怎么选](#philosophy-methodology-toolbox-怎么选) - - [和其他目录的边界](#philosophy-methodology-toolbox-和其他目录的边界) - [相关文档](#philosophy-methodology-toolbox-相关文档) - [目录](#philosophy-methodology-toolbox-目录) - [总体作业流](#philosophy-methodology-toolbox-总体作业流) @@ -164,20 +163,6 @@ ## 正文 -### 和其他目录的边界 - -- `concepts/` 负责 Vibe Coding 核心概念和工程思想。 -- `references/` 负责可执行的工程实践、技术栈、门禁和清单。 -- `research/` 负责新技术、新 repo 和趋势判断。 -- 本目录只保留能迁移到多个问题上的认知模型和方法论。 - -### 维护规则 - -- 本目录采用“线性总文档”结构，正文统一收敛到 `README.md`。 -- 新增内容时优先追加到对应大章节，并同步补充快速导航或完整细粒度目录。 -- 不再新增同级主题 `.md` 文件；如确需拆分，必须同步更新全仓索引、AGENTS 与 metadata。 -- 目录内只保留 `README.md` 与 `AGENTS.md`。 - ---
@@ -1319,14 +1304,6 @@ UserInput(组合描述模型) | 想理解代码、结构、状态和复杂度 | [编程之道](#philosophy-programming-dao) | | 想把探索过程变成可验证工程流程 | 本文件的方法论工具箱 | - -### 和其他目录的边界 - -- `concepts/` 负责 Vibe Coding 核心概念和工程思想。 -- `references/` 负责可执行的工程实践、技术栈、门禁和清单。 -- `research/` 负责新技术、新 repo 和趋势判断。 -- 本目录只保留能迁移到多个问题上的认知模型和方法论。 - ### 相关文档 diff --git a/docs/references/README.md b/docs/references/README.md index 78e52da..88335b7 100644 --- a/docs/references/README.md +++ b/docs/references/README.md @@ -342,23 +342,9 @@ - 先从 [工程实践](#reference-engineering-practice) 判断项目结构、代码组织、质量门禁和常见坑。 - 再从 [技术栈](#reference-technology-stack) 判断技术选型、组合案例和学习路径。 - 只查具体问题时，优先使用上方“快速导航”和细粒度目录。 -- 新增或调整参考资料时，直接编辑本 README 的对应章节。 ## 正文 -### 和其他目录的边界 - -- 检查清单、模板、质量门禁和经验类内容优先收敛到本 README 的工程实践部分。 -- 技术选型、技术栈组合和学习路径优先收敛到本 README 的技术栈部分。 -- 新技术、工具趋势、优秀 repo 解析先放入 [research](../research/README.md)，形成稳定工程参考后再放入本目录。 - -### 维护规则 - -- 本目录采用“线性总文档”结构，正文统一收敛到 `README.md`。 -- 新增内容时优先追加到对应大章节，并同步补充快速导航或完整细粒度目录。 -- 不再新增同级主题 `.md` 文件；如确需拆分，必须同步更新全仓索引、AGENTS 与 metadata。 -- 目录内只保留 `README.md` 与 `AGENTS.md`。 - ---
diff --git a/docs/research/README.md b/docs/research/README.md index b6225ff..5d943bb 100644 --- a/docs/research/README.md +++ b/docs/research/README.md @@ -27,23 +27,9 @@ - 用这里记录还在观察期的新技术、repo、工具趋势和工程范式。 - 如果内容已经成为稳定概念，迁入 `concepts/`。 - 如果内容已经变成可执行清单、模板或选型依据，迁入 `references/`。 -- 新增研究时同步补充快速导航、完整细粒度目录、`metadata/taxonomy.yml` 和 AI 引用索引。 ## 正文 -### 和其他目录的边界 - -- 稳定教程放入 `getting-started/` 或 `references/`。 -- 核心概念放入 `concepts/`。 -- 纯哲学模型放入 `philosophy/`。 - -### 维护规则 - -- 本目录采用“线性总文档”结构，正文统一收敛到 `README.md`。 -- 新增内容时优先追加到对应大章节，并同步补充快速导航或完整细粒度目录。 -- 不再新增同级主题 `.md` 文件；如确需拆分，必须同步更新全仓索引、AGENTS 与 metadata。 -- 目录内只保留 `README.md` 与 `AGENTS.md`。 - ---