Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 2.3 KB

File metadata and controls

43 lines (32 loc) · 2.3 KB

Docs 文档导航

目标:让人和 AI 只读取当前任务需要的最小文档集合。

1. 开始一个任务

  1. 根目录 AGENTS.md —— 开发流程、改动分级标准(本地/链路/治理改动)、Skills 入口
  2. 最窄的 app/service 自己的 docs/(如 apps/platform-api/docs/

不要默认读取整个 docs/ 目录。

2. 启动、部署和运维

3. 变更与发布

链路/治理改动的项目文档统一放在 projects/ 下,AI 判断出对应级别后自动用 plan-project Skill 创建,无需手动调用;单服务改动的留痕记录见对应 apps/{app}/docs/changes/,仓库级/工具链改动见 changes/。三者的选择标准见 AGENTS.md 的「文档组织」。

4. 目录说明

  • quickstart/:新人必读(架构、本地开发、部署)
  • guides/:开发规范
  • FEATURES.md:全仓库功能现状总览
  • changes/:仓库级/工具链级单项目改动记录
  • projects/:链路/治理改动的项目文档
  • decisions/:仓库级/跨服务技术决策(ADR)
  • archive/:过时内容归档
  • releases/:历史发布记录
  • runbooks/:运维操作手册