正文
获取原文件references/documentation-workflow.md
当前实现根据代码、配置、接口和运行证据描述;目标范围根据用户最新决定和批准需求描述。二者存在差距时保留未完成需求,不能根据代码当前能力改写用户目标。
唯一当前记录
多任务与跨会话工作引用 交付记录。README、计划、交接和验收报告引用同一需求、任务、验收及证据 ID,避免分别维护相互冲突的完成状态。
当前交接至少包含全部未完成项、阻塞和解除条件、最新用户约束及来源、已授权范围、当前改动、运行环境身份、证据有效性和下一可执行任务。不能只记录最近完成内容或一个建议下一步。
历史材料注明对应时间与版本;当前文档直接呈现当前事实。用户撤回内容后基于当前保留材料更新,不把已撤销方案继续写入发布说明。
文档生成
- 盘点需求、Schema/OpenAPI、源码、命令、配置、设计和真实测试结果,记录来源与版本。
- 按受众选择开发、运维、测试、安全、产品或外部使用说明;详细目录见 文档范围。
- 可执行规范派生机器文档;用户说明使用业务语言,内部实施细节只在影响用户决策时出现。
- API、状态、错误、角色和示例与当前实现一致;设计草案明确状态,缺少源码时不能描述为已经实现。
- 验证命令、链接、引用、路径、示例语法和对应权限,使用成熟格式工具。
- 发布说明依据实际变更及 发布状态,明确目标、版本、时间、产物和验证。
- 指标给出定义、来源、测量和适用范围;计划值、模板值和历史结果不得写为当前事实。
完成检查
文档创建、结构检查通过、内容审查和产品验收分别记录。调整文案不能关闭原始功能任务,修订交接不能把未完成承诺改成已完成。
输出实际文档路径、事实来源、检查结果、内容盲区及完整剩余项。默认不发布站点或发送外部消息;已有明确授权按目标执行。下一行动根据当前未完成状态生成,不重复要求已经完成且证据有效的步骤。