Files
skelet/docs/README.md
T

2.5 KiB
Raw Blame History

项目文档导航

项目定位、必读顺序和工作规则的唯一权威入口是 ../AGENTS.md,本文只做文档导航,不重复维护这些内容。

文档导航

  • ../AGENTS.md:所有 AI coding agent 的仓库级权威入口。
  • ../CLAUDE.md:Claude Code 薄入口,指向 AGENTS.md。
  • ../tasks.md:根目录任务入口,指向 06-tasks.md。
  • ../progress.md:执行历史流水,只追加记录任务执行、验证、阻塞和决策。
  • AI 开发入口:每轮开工流程和任务领取规则。
  • 项目愿景:为什么做、为谁做、产品原则、非目标。
  • 需求:MVP 要什么、怎么算达成、范围边界决策。
  • 技术栈:技术选型、运行命令、依赖纪律。
  • 架构设计:系统结构、数据模型(含 AI 友好度评分维度的唯一权威定义)、关键风险、开发顺序。
  • 编码规则:AI 写代码前必须遵守的硬约束。
  • 任务看板:按依赖拆分的小任务,每轮只做一个。
  • API 合约:MVP 不提供公开 API,记录 Wagtail 路由和后续 API 边界。
  • 路由与页面结构:前台页面、后台路由、页面职责和组件归属。
  • 当前实现状态:当前仓库现实状态、可运行命令和下一步任务。
  • 收尾检查清单:会话结束前逐项检查。
  • Harness 参考:失败模式对照、单轮评审表、健康度追踪、已有代码接入清单。按需查阅,不在每轮必读链路。
  • ../init.sh:标准启动与验证入口脚本(init.ps1 为 Windows 可选辅助)。

任务 / 进度 / 当前状态

  • 06-tasks.md 维护任务看板:任务 ID、依赖、验收要点和状态。
  • ../progress.md 维护执行进度:每轮实际做了什么、跑了什么验证、遇到什么阻塞、做了什么决策。
  • current-state.md 维护当前快照:当前目录、当前可运行命令、已完成任务摘要和下一个可领取任务。

维护原则

见 ../AGENTS.md 的工作规则:需求变化先改 02-requirements.md,技术方案变化先改 03-tech-stack.md 和 04-architecture.md,代码现实变化后同步 current-state.md、06-tasks.md 和 ../progress.md。