ARTICLE · INTELLIGENCE

战地情报 · 详情页

来自尧图项目组的一线实战观察与深度解析

软件测试技术文件Word写作指南:从能看写到能审能归档

软件测试技术文件Word写作指南:从能看写到能审能归档 软件测试技术文件Word这个词乍一看平平无奇真正做测试的人都知道它是整个软件测试项目里被吐槽最多、又不得不认真对待的交付物。需求评审要它测试计划要它用例评审要它缺陷报告要它验收归档更要它。很多团队内部用 Wiki、用 Excel、用飞书文档可一旦客户、监理、第三方测评机构介入最后拍板的几乎永远是那份 Word 版技术文件。这篇文章不聊测试方法论的大道理就讲怎么把一份软件测试技术文件从“能看”写到“能审、能查、能归档”重点落在 Word 实际操作、格式规范、常见坑和长文档维护上。适合刚入门被文档折磨的测试新人也适合带项目需要统一模板的测试组长看完可以直接照着搭自己的模板。1. 软件测试技术文件到底是什么为什么必须用 Word 来写1.1 技术文件在测试项目中的定位软件测试项目里技术文件不是“写文档”这么简单它承担了三层职责一是承上启下把需求、设计、测试策略这些上游信息翻译成可执行、可验证的测试方案二是过程留痕让每个阶段的评审、执行、缺陷处理都有据可查三是交付验收很多项目尤其是政企类、嵌入式、金融类项目没有完整的测试文档测试报告写得再漂亮也过不了验收。我见过不少测试工程师写代码、搞自动化很溜一到写 Word 文档就头疼。头疼的原因倒不是不会写字而是不知道技术文件应该包含什么、每部分写到什么深度、格式怎么统一。实际上把一份测试技术文件拆开看它就是一个标准的“计划—用例—记录—报告”闭环你只需要按照项目规模去裁剪章节比想象中简单。1.2 技术文件的核心读者与用途写技术文件之前先问一句这份文档到底给谁看这个问题决定了内容颗粒度。给项目经理和客户看重点在测试计划、测试结论、需求覆盖率、风险说明不要堆砌用例编号给开发人员看重点在缺陷报告、复现步骤、日志定位信息、接口入参出参不要写得云里雾里给测试组内部看重点在用例设计思路、测试数据准备、环境配置方便复跑回归给第三方测评或审计看重点在流程符合性、记录完整性、版本一致性每一处结论都必须能从需求编号、用例编号、缺陷编号反查到底。同一份文档不同读者关注的章节完全不同所以写之前先列读者清单再定优先级千万别一上来就把模板里的所有章节全部填满。1.3 为什么选择 Word 而不是 Markdown、Excel、Wiki很多人问我为什么不用 Markdown 写测试文档再转格式Markdown 写轻量笔记确实舒服但软件测试技术文件有三个特点让它目前还是离不开 Word。第一长文档的结构化能力。几百页的测试用例、几十页的测试报告需要多级标题、目录、页眉页脚、交叉引用、题注索引Word 的样式和导航窗格配合起来效率很高。第二评审和批注生态。客户、监理、质量部评审时用 Word 的修订、批注功能痕迹可追溯这个流程在多数公司是刚需。第三格式兼容与打印归档。PDF 可以归档但评审过程要改要批注还是要回到 WordExcel 适合管数据但成文的技术文件用 Excel 交付显得太随意。不是说 Word 没有缺点公式、图片、表格多了之后很容易崩、很容易样式错乱但这些问题都有对应的处理手法后面会逐一讲清楚。2. 一份 Word 版软件测试技术文件的完整骨架2.1 一级结构从测试计划到测试总结根据我接触过的几十个项目软件测试技术文件最实用的一级结构是七到八章每个项目按需裁剪第一章概述写项目背景、测试目标、测试范围、术语定义第二章测试依据与参考文献列需求规格说明书、设计文档、国家或行业标准比如计算机软件测试规范、客户提供的验收标准第三章测试环境与工具写软硬件环境、网络拓扑、测试工具、权限账号第四章测试计划写进度安排、人员分工、风险分析、准入准出条件第五章测试设计写测试策略、测试方法、用例设计思路、需求追踪矩阵第六章测试执行记录写执行过程、用例执行结果、缺陷统计、回归记录第七章缺陷分析与质量评估写缺陷分布、剩余风险、质量结论第八章测试总结与建议写结论、遗留问题、改进建议这套结构的好处是符合大多数公司和第三方测评机构的评审习惯需求到测试结论的逻辑链完整。小项目可以合并章节比如把测试计划并到测试设计里但“概述—依据—环境—计划—设计—执行—评估—总结”这个链条最好不要断。2.2 每个章节的写作要点与常见误区概述章节最常见的误区是复制粘贴项目背景写得像产品宣传稿。正确的是写清楚这个系统由哪些模块组成、本次测试覆盖哪些功能点、不覆盖哪些范围一句话能说清的不要说三段。测试范围尤其要写边界比如“本次测试范围为核心业务模块不包含第三方支付渠道的兼容性验证”边界不写清楚后期验收容易被钻空子。测试依据章节不能只写“依据需求规格说明书”要写文档编号、版本号、评审日期。标准引用也要写版本号比如“参照某标准 2018 版”和“参照某标准 2006 版”测试项目完全不同。软件行业里因为依据版本写错导致验收争议的案例不少这块宁可啰嗦也别省。测试环境章节常见误区是只写“服务器两台、客户端若干”完全没有配置信息。正确写法是把服务器型号、操作系统版本、数据库版本、中间件参数、客户端浏览器版本全部列清后面缺陷复现时环境信息就是第一排查依据。2.3 模板与样式先行页眉页脚、多级编号、目录写长文档最忌讳边写边调格式。正确的流程是先设计模板再写内容。模板要做的第一件事是设置样式正文样式、标题 1、标题 2、标题 3、题注、表格正文这些样式的字体、字号、行距、段前段后都要统一。个人经验是正文用五号宋体、行距固定值 20 磅标题用黑体或微软雅黑标题颜色不用花哨黑色或深蓝色即可公司有品牌色就按品牌色来。多级编号一定要挂在样式上而不是手动敲“1.1”“1.2”。在 Word 里通过“定义新多级列表”把标题 1 绑定到一级编号标题 2 绑定到二级编号这样你后面调整章节顺序时编号会自动重排不会出现“1.2 下面接着 2.1”的尴尬。目录用“引用—目录—自动目录”生成内容写完再更新目录快捷键 CtrlA 全选后按 F9 即可批量更新域。页眉页脚提前设置页眉放公司名称或项目名称页脚放页码双面打印的还要分奇偶页。如果文档分多个部分要用不同页码格式比如前置部分用罗马数字、正文用阿拉伯数字必须用分节符不能用“页码格式”硬改否则会乱。3. 核心实操在 Word 里写出专业测试文档3.1 表格用例表、缺陷表、需求追踪矩阵的规范写法软件测试技术文件里表格是主角用得最多的三张表是用例表、缺陷表、需求追踪矩阵。用例表建议最少包含用例编号、关联需求编号、用例名称、前置条件、测试步骤、输入数据、预期结果、实际结果、优先级、执行人、执行时间、备注。列太多放不下时优先保证“测试步骤、输入数据、预期结果”三列清晰其余信息可以用简短编码。缺陷表比用例表更难写很多新人要么只写“页面报错”要么把整个操作过程洋洋洒洒写一大段。规范的缺陷描述应该是一条独立的可复现场景软件版本、环境、操作路径、具体步骤、预期行为、实际行为、日志截图。有一个很实用的写法叫“Given-When-Then”给定什么条件执行什么操作然后观察到什么结果把这个结构写清楚开发第一遍就能看懂。需求追踪矩阵是评审重点用来证明每条需求都有对应的测试用例每条用例都关联了需求。建议用两列或三列需求编号、用例编号、测试结果。这个表在计划阶段创建执行阶段持续更新最后和测试总结一起提交覆盖率一目了然。3.2 公式、伪代码与算法表示AxMath、MathType 与代码块的选型测试技术文件里如果涉及性能计算、算法校验、加密逻辑公式和伪代码就逃不掉。Word 里公式工具有三派MathType、AxMath、Word 自带的公式编辑器。MathType 是传统老牌兼容性好期刊投稿常用但它的快捷键和 Word 原生公式经常打架。我遇到最多的情况是装了 MathType 之后用 AxMath 插入公式却跳出 MathType 的编辑框或者反过来这是因为两套插件抢了 Word 的 OLE 接口后面第 6 节会专门说怎么处理。AxMath 是国产公式编辑器界面简洁支持 LaTeX 输入个人觉得日常写测试文档足够性能计算、覆盖率公式都能搞定。Word 自带公式编辑器的好处是不用装插件、文档发到别人电脑上不会丢公式缺点是复杂公式编辑效率低。伪代码和代码片段不要用公式编辑器写更不要用截图。正确做法是插入单行或多行代码块或者用一个无边框表格把代码包起来设置等宽字体。算法伪代码常见格式是每行编号、关键字加粗、缩进表示逻辑层级这个在 Word 里直接用段落编号和字体加粗就能模拟。如果代码量很大建议把代码放附录正文只放关键片段。3.3 图片、图表与截图Visio 图片的插入与格式问题业务流程图、时序图、状态图测试文档里经常要用Visio 是很多公司的标配。但 Visio 图插入 Word 后有一个经典的坑图片只显示一半或者复制进 Word 之后变成了一张位图放大就模糊。原因是默认粘贴方式是嵌入 OLE 对象Word 需要调用 Visio 渲染换了电脑没装 Visio 就只显示缩略图或者灰色框。稳妥做法是在 Visio 里选中图形另存为 PNG 或 EMF 格式再插入 Word。EMF 是矢量格式放大不模糊但要生成 PDF 时有机会变形所以最保险的是导出为高分辨率 PNG比如 300 DPI再设置图片宽度和版式。流程图这种图宁可截大图也不要放大到模糊文档里出现模糊的架构图评审印象分会大打折扣。截图也有技巧不要直接 CtrlC 整屏粘贴应该用截图工具只截关键区域去掉无关的桌面、时间、浏览器标签。测试截图建议统一宽度比如正文宽度保持一致性。如果截图带操作步骤用 Word 的“插入—屏幕截图”裁剪也行但要注意每张图加图注交叉引用到正文。3.4 参考文献与交叉引用Zotero、EndNote 的接入测试技术文件里的参考文献虽然不像学术论文那么严格但客户评审时也很看重。规范做法是在“测试依据”章节用参考文献格式列出所有文档正文用交叉引用指出“详见文献[3]”。Word 里管理参考文献轻量方案是直接用编号列表手动维护中等方案是交叉引用加上书签重量级方案是 Zotero 或 EndNote 插件。Zotero 的优势是免费、跨平台而且在 Word 里的插件可以实时插入引用、生成参考文献表。EndNote 是老牌工具在医学、理工科用户群里渗透率高Word 2024 里添加 EndNote 的方法是先安装 EndNote 桌面版再到 Word 的“文件—选项—加载项”里检查 EndNote Cite While You Write 加载项是否启用如果没启用需要退出 Word 重新安装对应版本的加载项。对大多数测试项目我建议用轻量方案维护一个编号列表正文用交叉引用。这样不引入插件依赖文档发出去不会因为别人没装 Zotero 导致引用编号乱码。如果领导一定要标准格式再上 Zotero。3.5 从 Word 到 PDF评审版与归档版的输出技术文件最终要交 PDF所以 Word 转 PDF 的质量要专门验证。常见问题是字体丢失、表格串页、图片变形、公式错位。Word 转 PDF优先用 Word 自带的“文件—另存为—PDF”不要用第三方虚拟打印机第三方打印会把超链接、书签、目录跳转丢掉。转 PDF 之前要做三件事第一更新目录和所有交叉引用按 CtrlA 再按 F9第二全局检查字体安装的字体在自己电脑上没问题但 PDF 里如果嵌入了换设备打开就不变建议正文只用常见字体第三检查表格行高和跨页表格跨页时要在“表格属性—行—允许跨页断行”里设置同时勾选“在各页顶部重复标题行”。如果文档是从 Markdown、Typora 转过来的务必先在 Word 里清理一轮自动生成的 HTML 样式。Markdown 转 Word 的工作流团队里可以用 Pandoc 或 Typora 导出但在正式评审前必须手动处理样式我曾经收到过同事从 Typora 导出的 Word正文全是灰色边框的表格样式就是因为 HTML 内置样式没清理体验很差。4. 测试技术文件的进阶技巧宏、通配符与长文档维护4.1 宏安全设置与自动化批处理Word 宏对写测试文档的人来说是一把双刃剑。好处是可以用 VBA 批量处理重复操作比如一键格式化所有用例表格、批量替换编号前缀、一键导出所有图片坏处是打开陌生人发来的文档时宏可能携带恶意代码。Word 默认会禁用宏并提示这就是很多人被“宏安全问题”卡住的原因。要安全使用宏第一原则不要开启“启用所有宏”而是把来源可信的文档放在受信任位置。具体操作“文件—选项—信任中心—信任中心设置—受信任位置”添加一个专门存放项目模板和宏文件的文件夹然后把宏文件拷进去。这样打开自己团队的文档时宏不会被拦外来文档依然保持警告状态。宏安全问题的另一个常见场景是公司内部下发了启用宏的文档结果每个人打开都弹“宏已被禁用”。解决办法不是让每个人修改安全设置而是让文档管理员把文件放到共享的受信任位置或者对文档进行数字签名。测试团队里我建议由文档负责人统一维护宏模板其他人只使用模板不要各自为政。4.2 Word 通配符查找替换从基础到高阶长文档测试文件里最耗时间的操作往往是全局替换。比如给所有用例编号加前缀、把所有“测试要点”改成“测试重点”、把手工换行改成段落标记。Word 的通配符查找替换用熟了能节省大量时间。先记住几个基础通配符问号?代表任意单个字符星号*代表任意字符串方括号[ ]代表字符集合{n}代表重复 n 次。例如要把形如“TC001”“TC002”的编号改成“TEST-CASE-001”可以查找TC([0-9]{3})替换为TEST-CASE-\1前提是勾选“使用通配符”。这里[0-9]表示数字{3}表示连续三个\1表示第一个括号捕获的内容。再高级一点查找空行可以查^p^p替换为^p查找手动换行符^l替换为段落标记^p。表格里多余的空白段落、尾随空格也可以用通配符批量清理。通配符的坑是替换时容易误伤所以替换前一定先“全部查找”看预览或者先在副本上测试别直接在原稿上操作。我吃过一次亏本来只想删空行结果把表格里的段落标记全部删掉表格结构直接崩了从那以后凡是复杂替换一律先备份。4.3 长文档的性能问题分节、主控文档、拆分协作测试技术文件一旦超过两三百页Word 就开始变得迟钝输入卡顿、滚动卡顿、目录更新卡死。遇到这种情况第一反应不是换电脑而是检查文档里是不是堆积了大量高分辨率图片和复杂表格。长文档维护有几个实用原则。图片插入前先压缩用“图片工具—压缩图片”选择 150 DPI 或 96 DPI打印时可再用原图大表格不要几百行堆在一个表格里拆成按模块分的小表格表头统一样式不要直接改“正文”模板而是新建自己的样式否则容易和 Word 默认样式冲突。多人协作写测试文档时不要用“共享一个 Word 文件”的方式硬扛那只会制造冲突和版本灾难。推荐两种方案一是把文档按章节分成多个子文档用 Word 的“主控文档”功能管理但这个功能实际使用中偶发链接丢失另一个更稳的方案是先用协同工具各自写最后合稿到统一模板或者用 Git 配合文本格式管理但这对团队技术要求高。我目前用的是“一个主模板 多人分别填章节 专人合稿”的方式效率和稳定性的平衡最好。5. 项目实战从零搭建一份可复用的测试技术文件模板5.1 准备阶段与写作流程建议所有测试团队都维护一套自己的 Word 模板不用每次从零开始。搭建模板的步骤第一确定模板目录结构封面、修订记录、目录、章节模板、附录。封面要包含项目名称、文档编号、版本号、编制人、审核人、批准人、日期这些不要做成普通文字而是用“内容控件”或“域”方便以后自动更新。修订记录用表格写版本号、修订日期、修订人、修订说明、审核意见。第二定义样式体系。打开模板依次设置标题 1、标题 2、标题 3、正文、表格文本、题注、页眉、页脚的样式每个主题都用具体字体字号卡死不要用“默认”。表格默认无边框或三线表按公司规范来。第三插入自动化的目录、图目录、表目录。图目录和表目录是加分项用“引用—插入题注”给图片和表格编号再插入图目录/表目录。第四写一节“填写说明”放在模板后面告诉团队成员每个章节写什么字数在几百字即可。有人说模板的填写说明是给新人最好的培训材料我深有体会。5.2 将测试用例、缺陷报告落地模板里测试用例章节的落地我推荐两种方式轻量项目直接内嵌表格大型项目建议用例用工具管理比如 TestLink、PingCode、禅道再定期导出到 Word 归档。内嵌表格时注意列宽分配。总宽度固定为 A4 有效宽度用例编号列窄一点测试步骤列最宽。Word 里设置表格列宽时先选中整张表设置“表格属性—首选宽度—按百分比或固定厘米数”再逐列设置。很多新人抱怨表格列宽无法拖动是因为表格设置了“自动调整—根据内容调整表格”改成“固定列宽”就能拖动了。缺陷报告章节同样做成模板格式至少包含表头信息和缺陷描述两部分。缺陷标题要遵循“模块操作现象”比如“登录模块—输入正确账号密码后提示网络异常”不要写“登录失败”。严重等级、优先级、缺陷状态用下拉列表内容控件这样统计时更好筛。5.3 评审、修订与版本管理测试技术文件从初稿到归档通常要经历多轮评审和修订。评审时用 Word 的修订模式是最好的不要一边开会一边在共享屏上直接改文件。参会人在自己副本上打开修订统一收集意见后由文档负责人合入这样能追踪每条意见的闭环。版本管理上文件命名规范要统一项目名文档类型版本号日期状态例如“XX项目_软件测试计划_V2.3_20250115_评审稿”。不要出现“最终版”“最终版2”“打死也不改了版”这种命名版本库用 SVN 或者 Git 都行关键是有分支和标签意识。每次评审后更新修订记录写明改了什么、为什么改这个习惯在项目结束后回看优势非常明显。特别是涉及测试范围变更时修订记录是保护测试组的证据没有记录后面客户问“这个模块当时测试了吗”只能吃哑巴亏。6. 常见问题与排查技巧实录6.1 表格列宽无法拖动、快捷键粘贴失效表格问题排在第一位的是列宽无法拖动。大多数情况是表格属性里勾选了“自动调整—根据窗口调整表格”或者表格处于“根据内容调整表格”模式。选中表格菜单栏会出现“布局—自动调整—固定列宽”改完就能拖了。如果多列宽度不一致可以先选定整列直接输入精确的厘米数。快捷键粘贴失效也很常见尤其是从浏览器复制内容到 Word 时CtrlV 没反应。这时打开“文件—选项—高级—剪切、复制和粘贴”查看粘贴是否被设置成了“仅保留文本”或者被某个加载项拦截。还有一个隐蔽原因是打开了多个 Word 文档剪贴板冲突重启 Office 就好。粘贴时如果想统一格式我一般用 CtrlShiftV 或右键“只保留文本”避免把网页里的底色和边框带进测试文档。6.2 MathType 与 AxMath 的公式冲突公式工具冲突是我接手测试文档时被问得最多的问题之一。现象就是标题里描述的“在 Word 里用 AxMath 插入公式跳出来的却是 MathType”或者反过来。原因很简单MathType 和 AxMath 在 Word 里都注册了 OLE 对象抢占了公式对象的激活程序。排查步骤先看插入公式时是哪个工具被激活。在 Word 里“文件—选项—加载项”查看“COM 加载项”里勾选了哪些公式插件。如果两个都勾选建议只保留当前要用的那个另一个禁用。如果禁用后还跳错打开控制面板卸载其中一个公式工具装完重启 Office 再试。更深层的办法是改用 Word 自带的公式编辑器这样根本不存在冲突但代价是 MathType 的 LaTeX 输入快捷键没了。若要在 Word 里把已有公式转 LaTeX可以用 MathType 的“转换公式”功能或者复制公式为 LaTeX 源码。AxMath 也支持从图片转 Word 公式那个功能适合处理从 PDF 里截出来的公式图片识别率看清晰度一般作为辅助手段。6.3 字体、图片与兼容性常见坑字体坑最典型的是在 A 电脑装了一个自定义字体Word 里看着正常发给 B 电脑没有该字体直接替换成宋体排版全乱。我碰到过“安装了 wechat 字体Word 里认Photoshop 里却不认”实际上是字体文件只安装了用户级而非系统级或者字体本身只为某些应用注册。解决办法是项目文档一律使用宋体、黑体、微软雅黑、Times New Roman 等通用字体特殊字体只用于封面和海报不用于正文。图片和 Visio 的坑前面提过这里补充一个 PDF 转 Word 的场景。有时候客户只给了 PDF 版需求文档你需要把它转成 Word 做标注对比。在线转换和本地工具都有风险在线工具上传涉密需求不妥本地转换工具对扫描版 PDF 无能为力。我的做法是文字版 PDF 用 Adobe Acrobat 导出 Word扫描版先 OCR再用 ABBYY FineReader 或 WPS 的文字识别转成可编辑格式。转完必须整体校对一遍表格和公式最容易出错。6.4 格式问题速查表整理一个实战排查表收藏下来能少吃很多亏问题常见原因处理办法表格列宽无法拖动自动调整模式设为固定列宽逐列设置精确宽度CtrlV 粘贴无反应粘贴选项被改或剪贴板冲突检查高级粘贴设置重启 Office目录更新后格式乱目录基于手动文本用“引用—目录”自动目录F9 更新Word 转 PDF 后表格跨页断头未设置重复标题行表格属性勾选“在各页顶部重复标题行”导出的 PDF 字体变形字体未嵌入另存 PDF 时勾选“嵌入字体”或只用通用字体公式双击跳到另一个工具MathType/AxMath 冲突在 COM 加载项里只保留一个公式插件Visio 图显示不全粘贴为 OLE 对象另存为 PNG 或 EMF 后插入打开文档宏被禁用信任中心阻止将文件放入受信任位置WPS 打开 Word 后样式错乱样式兼容性问题用 word 和 wps 双测统一样式或另存兼容格式还有一个兼容性问题团队里有人用 WPS有人用 MS Word。同一条虚线表格边框两边显示不一样。解决办法是团队约定主办公软件如果必须支持两套就在格式设置里避开高级边框效果用简单实线并在交付前用另一款软件做一次“验收打开测试”。我自己吃过亏用 WPS 排好的文档客户用 MS Word 打开表格宽度全乱了后来所有文档合稿完成后会强制走一遍双软件验证。7. 关于自动化导出 Word 文档的一些补充测试团队规模大了之后有人会问能不能直接用程序生成 Word 测试文档这是一个方向也有现成方案。常见思路包括Java 用 POI 操作 Word 并设置表格单元格宽度C# 用 OpenXML 在 Word 文档里插入变量生成报告前端用 js 库生成 Word 文档比如 docx 库还有团队用 Markdown 转 Word 的工作流配合自动化平台直接产出。这些思路适合生成固化格式的测试报告比如每日测试执行报告、自动化测试结果摘要。但要注意程序生成的文档通常只能做初稿涉及评审意见、复杂排版和人工判断的部分还是要人工介入。技术文件的价值在于表达判断和结论工具负责把数据摆上去判断还得人来写。开发自动化导出时我建议先手工写一份“黄金样例”作为测试基准再用脚本去对照。否则脚本写得很爽出来的文档格式却和手工版本差出一大截反而增加人工修复成本。8. 最后再分享几个写测试技术文件的土办法写了这么多年测试文档我发现决定文档水平的其实不是技巧而是几个土办法。把模板当作活文档不要一年不更新。每次评审提出的格式问题和内容缺失都回填到模板里模板会越来越贴合团队实际。写文档之前先画章节提纲和表格结构提纲定了再动手写不然写到一半章节逻辑换了返工成本很高。每次交付 PDF 前自己先打印一份纸质版或者用 PDF 阅读器过一遍电脑屏幕上看着正常的文档打印出来表格常常是断裂的这个细节很多人忽略。个人体会最深的一点测试技术文件不只是给项目一个交代更是给未来的自己留一条退路。项目过了三个月客户突然问某个功能当时怎么测的你能从归档文档里十分钟内找到对应的用例和缺陷记录那这份文档就真正产生了价值。写的时候多花半小时把记录补全后面省的是无数个加班夜。
RELATED READING

延伸阅读

更多一线实战笔记与深度复盘,助您持续精进