Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

仓库文档

这个目录用于存放仓库级文档。

并不是仓库里的所有 Markdown 文件都属于这里。有些文档会有意放在它们所约束的代码或工作流旁边:

  • README.mdDESIGN.mdAGENTS.md 保留在仓库根目录,因为它们是顶层入口文档
  • apps/web/*apps/admin/* 的设计文档保留在各自界面旁边,因为它们直接规定这些界面的规范

目录布局

顶层入口文档

高频入口文档保留在 docs/ 顶层:

  • RUNBOOK.md
  • COMMAND-CARD.md

docs/product/

当前产品边界、内容规则与验收基线:

  • current-boundaries.md
  • content-model.md
  • acceptance-criteria.md
  • public-copy-audit-2026-09.md:公共官网固定文案审查与优化建议

docs/architecture/

系统、admin 与数据模型设计:

  • architecture.md
  • admin-architecture.md
  • admin-information-architecture.md
  • admin-data-model.md
  • admin-data-model-fields.md

docs/operations/

开发、验证、部署与发布运维:

  • local-development.md
  • quality-assurance.md
  • deployment.md
  • production-config.md
  • launch-checklist.md
  • repository-review-2026-06.md
  • server-upgrade-and-cleanup.md
  • x-login-runbook.md

docs/archive/

历史范围文档、阶段性路线图和不再作为当前事实来源的材料:

  • README.md
  • product/v1-scope.md
  • product/implementation-plan.md

更新规则

仓库级的产品、架构与运维文档应放在 docs/ 下。

只有当文档明确属于某个应用或仓库入口点时,才应放在 docs/ 之外。

活跃文档应优先描述当前事实、当前流程和当前约束。

阶段性规划、历史范围或已经失效的叙述,应移入 docs/archive/,不要继续留在活跃文档路径中。