为什么文档在 BMAD 中至关重要
在 BMAD 方法中,文档不是附属品——它是 Agent 之间的通信协议,是项目知识的持久化存储。
文档层级
Level 0: README(项目概览)
Level 1: PRD、Architecture(核心设计)
Level 2: API Docs、Schema(技术细节)
Level 3: Code Comments(实现说明)
写作原则
1. 为最懒的读者写:关键信息在最前面
2. 为机器写:使用结构化格式
3. 为未来写:假设读者没有任何上下文
模板示例
# 组件名称
概述
一句话说明这是什么
快速开始
最简单的使用方式
API 参考
详细的接口说明
示例
真实的使用场景