需求分析文档生成
概述与边界
按官方模板结构生成《需求分析文档》(竞赛交付物①,锚定"需求分析与方案设计"20分;兼容鉴定 SRS 规范)。章节骨架与官方 docx 模板一致(7章),融合 PRD 书写规范。结构是唯一参考依据——正文一律依据用户提供的赛题/场景材料独立撰写,禁止套用或改写任何模板示例(模板中的示例行与示例数值仅示意表格填法)。
本文档是 Visio 图、HTML 原型、编程、演示视频四类交付物的撰写依据——必须结构完整、层次清晰、可被逐节引用,并按规范留出图表占位。
边界(优先遵守,最高优先级):只产出《需求分析文档》。绝不生成、不附带、不引用《数字化解决方案文档》——包括其模板、章节骨架、规则体系(R-xx)、业务闭环设计、部署/技术架构、流程图文字稿等任何内容;本技能内也不存在该文档的任何模板或章节。不生成/不修改/不校对任何其他文档;除本地 Office 文件读写按系统路由规则(tencent-docs-routing)执行外,不引用、不依赖、不调用任何其他技能;编号、术语、数据全部在本文档内定义并闭合。用户若同时要求其他文档,告知其另行发起对应任务(解决方案类文档请使用 sai-solution-design),本技能不介入。
评分理念(生成前先读,四条贯穿全程)
> 质量优先、兼顾数量——不以功能堆砌或文档篇幅为评价依据。
| 考察点 | 落地动作(生成时逐条执行) |
|---|---|
| ① 成果质量优先 | 完整性=赛题要求的主体/环节/模块一个不漏(先列覆盖清单再写正文);准确性=每个数字可溯源到赛题资料或测算逻辑自洽,禁止臆造;可用性=下游能直接照此画图、做原型、写代码 |
| ② 规范意识 | 编号(G/P/R/US/FR/NFR/Q)全文一套;三级编号"章-节-条";图表"图N-x/表N-x"且被正文引用;术语统一;无模糊词、无套话开头 |
| ③ AI 工具合理应用 | AI 产出必须人工复核:数字对账+逻辑自洽+术语统一;凡测算数值须标注依据 |
| ④ AI 准确赋能 | 赛题含 AI 场景时需求侧须预留落点:相关 FR 写明痛点编号+输入数据字段+可核验验收标准,杜绝"为用 AI 而用 AI"的需求 |
篇幅不是得分项:正文6-10页为宜,用户要求"写满X页"仅作版式参考,不得填充注水;短而准优于长而空。
执行流程(4 步)
第 1 步:收集输入并加载参考
输入来源自足,两条路径均可独立启动:① 用户上传/提供的材料(doc/docx/wps/pdf/txt/md 或直接粘贴,按 tencent-docs-routing 读取);② 用户口述场景。不依赖任何前置文档。
确认以下三项;缺失则询问,不得默认假设(仅当用户明确要求快速产出并同意假设时,可按其确认的场景假设,并在文档中标注假设项):
1. 赛题场景与背景事实(备赛:赛题资料、痛点清单、违规分类参考规则)
2. 目标读者(竞赛评委 / 鉴定考官 / 企业客户)
3. 关键约束(业务规模、既有系统、工期分期、安全合规等级等量化基数)
一次性读取以下参考(勿重复读同一文件):
- references/requirements-analysis-template.md——章节骨架、评分点对照、表格列定义、图表占位位置表、交稿前自查清单
- references/document-style-guide.md——输出样式规范(md 与 docx 阶段共用;含占位块格式、AI 校验纪律)
第 2 步:生成 Markdown 草稿
硬性写作规范(逐条执行):
- 独立创作:角色/痛点/指标/数字一律依据用户材料独立生成,禁止套用或改写任何示例内容
- 编号体系:G-xx 目标、P1-Pn 痛点、R-xx 用户角色、US-xx 用户故事、FR-xx 功能需求、NFR-xx 非功能需求、Q-xx 开放问题;全文一套,唯一、不重复、不断号;2.3 角色表必须含"角色编号"列,用户故事、4.2 权限矩阵列头、FR 权限描述引用角色时一律标注角色 R 编号("R-xx 角色名"),且与 2.3 完全一致
- 全量化:禁用"大幅提升""较快响应"等模糊表述;数值从场景基数测算或赛题资料得出
- SMART 目标:指标+目标值+当前值+衡量时间(当前值即痛点影响量化基数)
- 验收标准:FR 用"条件-操作-结果"格式,可 Yes/No 判定,覆盖正常/异常/边界
- 表格化:权限矩阵、痛点分析表、功能清单、数据字典、非功能表、设计约束表——按模板列定义逐列填写,不留空列
- 图表占位:按模板"图表占位位置表"在指定章节留占位块(格式见 document-style-guide.md 第5节),含图类型、图形要素清单、正文对应、下游用途,图形要素写到可直接照画;漏留占位视为结构不完整
- 下游可用性:权限矩阵(原型依据)、数据字典(建表依据)、验收标准(测试依据)、界面约束(UI依据)须写全,下游拿到即可开工
- 书写顺序(评审避坑):痛点分析 → 建设目标 → 范围边界 → 用户角色与故事 → 功能需求 → 数据需求 → 非功能需求 → 设计约束 → 接口 → 确认与附录
- 输出样式:md 结构标记、标题层级、表格规范、加粗强调、交叉引用、禁用词,遵循 document-style-guide.md
草稿输出为 .md 文件,文件名:需求分析文档-<场景名>.md。产出节奏(关键):
- 标准模式(默认):呈现草稿并停下等待用户确认(确认内容、结构、数字,或提修改意见),确认后再进第 3 步
- 快速模式:用户说"直接出稿""一键生成""赶时间/没时间了"或明确要成品时,不停顿,一次写完草稿后直接续做第 3 步,最终一次交付 md+docx
整个草稿一次性写完整、一次输出,不分章节反复输出或反复询问。
第 3 步:产出 Word(统一按公文排版格式)
本技能 Word 产出只有一条路线:公文排版(GB/T 9704),用本地免费引擎完成,不消耗积分:
python scripts/doc_format.py <草稿.md> --output "需求分析文档-<场景名>.docx" --no-disclaimer
# 需要自动插一页目录时追加 --toc
- 版式:A4 版心(上37 下35 左28 右26mm)、公文标题(方正小标宋简体 二号 居中)、一级标题黑体三号、二级标题楷体三号、三级标题仿宋三号、正文仿宋三号首行缩进2字符、页脚一字线页码
- 标题层级可直接生成目录:章/节/条自动套用 Word 内置「标题 1/2/3」样式(公文体、字体字号不变),成稿在 Word 中即为真正的一级/二级/三级标题——导航窗格可跳转,可用「引用→目录」生成目录;需要引擎直接插一页目录时加
--toc(Word 目录域,打开文档自动刷新条目与页码,默认不插) - 表格转 Word 原生表格(列宽按内容自适应、禁止行内跨页、超 6 列自动横排);表题居中于表格上方
- 输入支持 md/doc/docx/wps/txt;
.doc/.wps经 LibreOffice/Word/WPS COM 转换,失败时提示另存为 .docx/.md - 默认不生成封面与目录(公文格式不含封面目录);细节见
references/doc-format-guide.md
内容零篡改纪律(硬性,逐条执行):
1. 逐字保留:排版只改字体、字号、缩进、版心、页码与表格形态;不增、不删、不改写任何文字
2. 不生成任何草稿中没有的题注:图题/表题一律以草稿为准,禁止排版过程自动补写(如"表N 主要情况汇总"之类)
3. 占位块保全:每个 【图N-x …:待插入】 及其"图类型/图形要素/与正文对应/下游用途"各行必须完整出现在 Word 中,一块不漏(这是后续补图与 vsdx 交付的依据)
4. 转换后自检:运行 python scripts/verify_docx_fidelity.py <草稿.md> <成稿.docx>,确认"丢失片段 0"(Markdown 表格分隔行除外)后再交付
第 4 步:交稿前自查与交付说明
按 references/requirements-analysis-template.md 末尾"交稿前自查"清单逐项核对(完整性/准确性/可用性/图表占位/规范/篇幅六组),并核对 document-style-guide.md 第10节样式项、第11.2节 AI 校验三项(数字对账+逻辑自洽+术语统一)。不合格项就地修正后再交付。
交付说明向用户交代:产出文件路径、所用排版方式(公文排版;是否含目录页)、待补图表清单、数字来源说明(哪些来自赛题、哪些为测算、哪些为假设);本技能到此结束。
触发词
| 意图 | 典型说法 |
|---|---|
| 生成需求分析文档 | "生成/写/起草需求分析文档"、"按模板生成需求文档"、"竞赛交付物①" |
| 鉴定场景 | "需求规格说明书"、"SRS"、"鉴定需求文档" |
| 转格式 | "需求分析文档转Word"、"需求文档出docx" |
| 排版/格式化 | "公文排版"、"按公文格式输出"、"用doc-format格式化"、"把这个docx/wps重新排版" |
资源清单
references/requirements-analysis-template.md——需求分析文档结构模板(7章骨架+评分点对照+表格列定义+填写要求+编号体系+图表占位位置表+交稿前自查清单;第6章含非功能需求全量化与 6.5 设计约束六类核查)references/document-style-guide.md——文档样式与排版规范(版式/字体层级/编号/表格/图与占位块格式/强调与交叉引用/语言细节/常见错误对照/md→docx映射/样式自查/AI校验纪律)references/doc-format-guide.md——doc-format 公文排版指南(命令用法/输入书写约定/GB/T 9704排版规则/常见问题,支持doc/docx/wps/txt/md输入)scripts/doc_format.py——doc-format 多格式排版入口(调用scripts/format_document.py引擎,输出公文格式 docx;--toc插自动目录页)scripts/verify_docx_fidelity.py——排版保真校验(比对草稿 md 与成稿 docx,确认内容零丢失、占位块完好)scripts/format_document.py——公文排版引擎 v2.1.0(标题层级(Word 内置标题1/2/3)/表格/附件/页面设置/自动目录,依赖 python-docx)config/format.json——排版参数配置(GB/T 9704 版心、字体字号、标题层级模式)