Files
xas-skills/skills/erp-requirements-design/references/delivery.md
T

49 lines
4.4 KiB
Markdown

# Word 与 Markdown 交付要求
最终产物是业务 PRD,不是技术设计或验收报告。用户指定的格式、模板和位置优先。
## 文件与版本维护
1. 在对应业务目录保存同名 `.md` 和 `.docx`,默认文件名为 `业务名称产品需求文档-v0.1-YYYY-MM-DD`。日期用用户时区,版本取真实修订记录,不以“终稿”表示未确认稿件。
2. 新建稿件采用“主标题 → 版本记录表 → 业务正文”。版本表为“版本、修订日期、修订内容”,每个版本一行,初稿不虚构上一版。标题下不再重复副标题或版本、日期、状态行。
3. 持续编辑同一评审稿时保留维护入口。局部措辞、格式和删节一般更新当前版本并保留可恢复备份,不每次小改动都复制一套竞争版本。明确发布新基线、重要业务版本变化或用户要求留新版本时,按版本规则新建并指明最新文件。
4. 同一版本更新该行修订摘要,不把每次对话视为新版本或生成多行同名版本;未确认决策保持待评审。
5. Markdown 为维护源稿,Word 为排版版本。定点修改 Word 后同步源稿,核对章节、字段、权限、状态、图示和验收,避免两套内容分歧。
6. 删除或改写须在两种格式及相关引用中生效。后续生成基于最新源稿,不恢复已删除的资料说明、旧标题或元数据。
## Word 与图表制作
- 优先使用当前可用的 `documents` 技能及其声明的生成、渲染依赖,按该技能发现工作区运行时;没有该技能时,可使用已有、获准的等效 DOCX 生成与渲染工具。安装本技能不会安装这些依赖,不临时安装未知来源程序,不将作者机器路径写入可复用生成逻辑。
- 缺少生成或渲染能力时保留成果并说明限制,不以改扩展名代替 DOCX,不声称未执行的版面检查已通过。
- 使用 Word 标题样式,业务章节按 `1`、`1.1`、`1.1.1` 编号并对应提纲级别;文首版本记录不占业务章号。
- 中文字体和页码清晰,表格按内容设置列宽,允许换行并重复跨页表头;长段规则放正文。
- Word 嵌入可见流程图、泳道图和页面示意,保留文字说明;Markdown 图片引用有效,需要维护时保留图源。
- 示意与真实截图明确区分。图片段落不得因固定行高被裁切;检查图中文字、箭头、说明及页面位置。
- 图示及例子的数量按解释需要确定,不强制每份 PRD 使用固定张数,不新增无依据的业务页面。
## 内容与版面核对
内容核对涵盖两种格式的版本表、标题层级、菜单路径、字段、规则、状态、未决事项和验收。交叉引用用名称或章节;用户明确要求编号时再核对编号集合。图中角色、条件及入口与正文一致。
重点检查:
- 已确认菜单是否仍在待确认表内,图中是否存在旧路径。
- 删除技术式编号后,功能和验收覆盖是否仍然保留。
- 文首是否仍有重复副标题或版本日期状态行,版本表是否一版本一行。
- 已删除资料说明或旧标题是否被旧脚本、模板及副本恢复。
- 业务完成、人工登记及系统回执是否区分,虚构示例是否被误作证据。
版面核对需生成渲染页,检查字体、表格、图片、跨页表头、标题衔接、页码、空白与溢出。新文档及整体重排逐页检查;局部修改检查受影响页。文件能打开不等于版面已核验。
## 预览与保存内容不一致
用户反馈旧内容时,先读取实际保存的 Word 和 Markdown,核对路径、版本、修改时间及关键文字,按需核对当前预览文件。不能直接归咎于缓存,也不重复改写已经正确的内容。
保存内容正确时说明已核实的版本,提示刷新或重新打开。用户确认只是未刷新后停止排查,不清理应用缓存或修改无关设置。文件确实仍旧时,修改真实维护入口并重新核对。
## 交付说明
提供两个产物的可点击绝对路径,概括改动、关键未决事项及实际核对范围。小改动简短说明,不重复整份目录。文档确认、页面观察、业务验收和部署验证分开表达。
渲染图片、临时 PDF、备份及调试脚本留在独立工作目录。用户未要求时不追加 PDF、演示文稿、测试台账或技术设计。