Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 2.2 KB

DOCUMENTATION.md

File metadata and controls

47 lines (34 loc) · 2.2 KB

文档维护规则

文档根目录:docs/

文档层级

层级 权威文档 职责
仓库入口 README.md、AGENTS.md、ARCHITECTURE.md、HARNESS.md 项目概览、Agent 约束、架构摘要与验证契约
文档中心 docs/README.md 阅读入口和当前有效文档索引
详细文档 docs/... 审计、计划以及后续按需建立的专题资料

存放规则

内容 存放位置
代码库审计报告、Finding、任务与证据 docs/audit/
活跃计划与任务分解 docs/plan/

仅在仓库确有对应内容或用户明确授权时创建目录;不得创建空分类目录。

事实来源对应表

事实或主题 权威维护文档 引用入口 归档条件
产品定位、安装与用户命令 README.md docs/README.md 被新的用户文档明确取代时
架构边界与核心流程 ARCHITECTURE.md docs/README.md 被新的架构权威文档明确取代时
Agent 行为与安全约束 AGENTS.md docs/README.md 不归档,随仓库 Context 刷新
构建和验证命令 HARNESS.md docs/README.md 不归档,随可信验证入口刷新
代码库审计结论和证据 docs/audit/ docs/README.md 新快照使旧证据失效时由 Audit 标记状态
未来工作和任务进度 docs/plan/ 按需加入 docs/README.md 任务完成或被取代时

状态和详细决策只在权威维护文档中更新。入口文档保持简洁,只链接到权威文档,不重复正文。

导航规则

  • 每份当前有效文档应能从 docs/README.md 或其直接链接的专题索引到达。
  • 先阅读索引,再按需打开详细文档。
  • docs/audit/Report.md 由代码库审计流程维护;文档中心只保留简短入口。
  • 仓库级文档保持简洁,深层证据和状态留在对应专题目录。

归档规则

  1. 归档前先确定当前权威文档,并在历史文档中链接到它。
  2. 移动前将文档明确标记为“已归档”或“已被取代”。
  3. 更新所有项目内入站链接和当前有效索引。
  4. 除非用户明确批准删除,否则保留历史内容。