用途:为已完成的项目功能编写非技术性文档,说明功能做什么、为什么存在、如何运作,不涉及代码细节。文档以 Markdown 文件存放在 docs/ 文件夹。
主要能力:面向两类读者——非开发者(产品经理、设计师、干系人)与需要排查问题的 AI 智能体;建议创建 docs/README.md 作为功能清单与导航索引,仅在功能完成文档后加入索引,条目含功能名(链接)、相关功能、一句话摘要。
使用方式:每个功能一个 Markdown 文件,文件名小写并用连字符,如 user-authentication.md。模板结构包括:What It Does、Why We Built It、How It Works(含 Key Components、Data Flow)、User Experience、Expected Behavior(成功与错误场景)、Business Rules、Dependencies、Common Issues & Edge Cases、Future Considerations。
适用场景:用户可见功能、管理后台流程、业务规则与条件逻辑、权限与角色行为、第三方集成、后台处理(定时任务、队列)、自动化、自定义数据流、生命周期状态转换。
限制与注意:不引用代码(函数名、类、文件路径)、不写实现细节(数据库结构、API 端点、技术架构)、不用开发者术语;对不明确行为应向业务方确认后再记录。文档应在用户可见行为或业务逻辑变化时更新,而非代码变化时。具体安装命令与运行方式暂未提供。