跳转至

Backlog 与内部文档

本页解释 LAV2 日常开发中使用的两套内部文档系统:

  • Backlog.md:用于计划中的工作与范围控制
  • backlog/docs/:用于项目内部参考资料

Backlog.md 是事实来源

对于任何需要规划、决策或跟踪的非平凡工程工作,都应使用 Backlog.md。实际含义是:

  • 在开始实现前先搜索是否已有现成任务
  • 如果这项工作涉及设计选择或多个步骤,就创建新任务
  • 将实现计划、备注、范围变更与完成状态记录在任务中,而不是散落在临时聊天记录或草稿文件里

轻量、机械性的编辑不一定需要任务,但真正的特性开发、重构与 bug 调查都应该进 Backlog。

期望的开发流程

  1. 开始前先搜索 Backlog
  2. 开工时将任务切到 In Progress
  3. 在改代码前把实现计划写进任务
  4. 当出现决策或阻塞时,把备注补进任务
  5. 运行相关检查
  6. 当验收项满足时,及时更新 acceptance criteria

这与仓库的 Backlog 工作流保持一致,也能让任务本身成为下一个贡献者或 agent 可直接接手的交接记录。

如何阅读 backlog/docs/

backlog/docs/ 不是公开文档站点的一部分,它用于存放在开发过程中仍然有价值的内部参考笔记。

应把这些文件视作工程参考资料。如果某个流程已经成为正常贡献体验的一部分,通常应在 docs/ 中做摘要,并从公开开发指南中链接过去。

各类文档来源之间的关系

  • docs/:面向外部、可导航的公开文档站
  • CONTRIBUTING.md:仓库级精简贡献入口
  • .github/prompts/:面向贡献者与 coding agents 的 prompt 风格操作说明
  • backlog/docs/:内部工程参考资料
  • backlog/tasks/:已承诺工作的记录、计划、执行备注与验收标准

维护规则

当某个开发流程发生变化时,应更新贡献者实际会看到的那一层事实来源:

  • 稳定、面向贡献者的说明更新到 docs/
  • 面向 agent 的操作 prompt 发生变化时更新 .github/prompts/
  • 内部工程参考发生变化时更新 backlog/docs/
  • 如果改动会影响当前范围或执行过程,还需要同步更新 Backlog 任务