lexgo/docs/delivery

generated: true (请先修改 Gitea Wiki，禁止直接编辑本文件) wiki_page: Delivery-Documentation-Guide wiki_url: https://git.ilapage.cn/OPC/lexgo/wiki/Delivery-Documentation-Guide.- wiki_revision: 2fded6b8141921cffd4a6f9b9c43ea9163b33a6b synchronized_at: 2026-09-10T06:27:46Z

交付文档指南

什么时候需要交付文档

按真实读者和可验证产品版本创建。当前负责人需要项目档案、需求范围和工作量估算；开发维护者需要业务边界、工作流与验证入口。尚无可运行产品，不预建空白用户/管理员手册。

受众与文档选择

学习者手册在 M1 形成可用闭环后编写，覆盖导入、阅读、保存和复习；部署维护指南在环境及常驻服务确认后编写，覆盖版本、配置、备份恢复和升级；管理员说明覆盖语言、词典、用户及备份授权。具体交付负责人、可见范围和验证人待确认。

内部文档与交付文档边界

交付文档仅包含读者所需操作与限制，不泄露凭据、内部配置或个人数据。测试示例明确使用虚构数据。研究建议不能当成对外功能承诺。

编写和维护流程

确认读者与版本 → 基于真实流程编写 → 执行操作验证 → 记录已知限制 → 人工验收。通用岗位模板仅供后续使用，不因模板存在认为手册已交付。

最小验收清单

入口可访问、步骤与版本一致、预期结果明确、错误可恢复、权限说明正确、敏感信息不外泄。无法执行的步骤明确标注，不能作为已验证交付内容。