三份文档与方法论沉淀
目标
三份功能文档加一份方法论文档各管一个维度:FEATURES 记录功能生命周期,CHANGELOG 记录技术改动,RELEASE_NOTES 面向用户说明变化,METHODOLOGY 沉淀产品决策与取舍。
操作步骤
FEATURES 与 CHANGELOG 分别记录状态和改动
FEATURES.md 是功能点的主要事实源,状态从规划中、开发中到已完成或已取消流转,每个功能带历史沿革,记录初始需求、方案变更及原因和最终实现,取消的功能也保留并注明原因。CHANGELOG.md 按时间倒序用固定字段表格记录问题或需求、根因或方案、改动范围、影响面和状态,类型包括 BUG、FEAT、REFACTOR、PERF、DOCS。
RELEASE_NOTES 面向用户,METHODOLOGY 保存取舍
RELEASE_NOTES.md 面向真实用户,只写用户能感知的变化,每条都要能回答'这对我有什么用',禁止写调试功能、技术实现细节和用户无感知的改动,每条不超过三句话,版本号遵循 SemVer。METHODOLOGY.md 主动沉淀产品原则、设计决策记录、用户体验偏好和反模式,AI 识别到'为什么这样做'、否决方案的理由或 UI/UX 偏好时直接写入。
把 AI 能读取的文档放进项目事实源
需要让 AI 自动继承的文档,应放在它有权限读取、且纳入版本管理的事实源中。外部 Notion、飞书或知识库并非天然不可用,但必须通过连接器、导出或显式提供进入上下文;记录时间应读取系统时间。
完成检查
CHANGELOG 和 RELEASE_NOTES 为什么分开: CHANGELOG 面向开发者,记录技术细节和根因,RELEASE_NOTES 面向用户,只写可感知的变化。混在一起会让用户读到无意义的技术内容,也会让开发者找不到真正需要的技术记录。
为什么方法论文档要进入项目事实源: 只有被当前工具授权读取或显式提供的内容才会进入上下文;外部文档也可以使用,但需连接器、导出或引用流程。