技术文档应该怎样裁剪？从谷歌公司用ACC替代测试计划说起

谷歌公司是在践行敏捷实践的。敏捷的价值观之一“注重可用的软件胜于事无巨细的文档”也在谷歌公司得以实践。

在Google，测试计划也曾如同传统的做法那样——遵循事先制定的模板，使用word编写，并通过评审，作为工程技术文档。但随着敏捷的践行，测试计划逐渐被ACC方法所替代。

ACC(Attribute Component Capability，即特质、组件、能力，它能够反映测试人员对软件系统的认知程度，以及要测试的目标。ACC在谷歌公司已经有了工具支持，这个工具就是“GoogleTest Analytics”。

ACC的编写指导原则如下：

避免散漫的文字，推荐使用简明的列表。测试计划的受众对象是测试工程师，所以它不需要反复重复那些各个技术文档中都有的系统背景介绍，不需要过多地解释那些在其他技术文档中已经清楚地阐述的功能，不需要文字多么优美，它只需要测试人员所需的干货——软件系统的特质、组成和能力，所以使用图表来描述这些内容会更让测试工程师接受。
简洁。测试计的长度无关紧要，计划的大小只与测试的规模（测试项的多少）有关，不要把不重要的、无法执行的东西放进测试计划。
渐进式的描述(Make it flow)。测试计划的每个部分(特质、组成和能力)都是前面部分的延伸，如果测试工程师只想对产品的功能有一个初步的印象，他只要阅读特质部分就可以了；如果他希望了解更多的细节，那么他可以继续读下去。
指导计划者的思路。测试计划应能帮助计划者厘清产品功能及其测试需求，从高层概念过渡到可以被直接实现的低层细节。
最终结果应该是测试用例。测试计划应能清楚地指导测试用例的编写。

从谷歌公司替代测试计划文档的方法中，我们可以获得一些技术文档裁剪的经验：

内容胜于形式。如果我们需要对技术文档进行裁剪，那么文档是否具备GJB438B所规定那些章节条目并不重要，字体样式大小和段落格式也不重要，最重要的是它应该阐述清楚的技术内容阐述的是否完整，准确。
图表胜于文字。“一图胜千言”。表格也能够比普通的文字表述更清晰，也更简洁。
简要胜于冗余。技术文档中的内容都应言之有物、有用，毫无意义，甚至对本文档无意义的内容不应出现在文档中。
确保核心胜于事无巨细。每个技术文档都有其核心内容——需求文档的核心是那些需要实现和确认的需求，设计文档是软件的组成部件、接口、部件的详细设计，测试计划是测试项，测试说明是测试用例，只要这些核心内容描述清楚、准确、完整、无歧义，其他内容描述得简略一些也是可以接受的。

工作产品的裁剪也是裁剪的一种方式。对于实施GJB5000的组织可以按照以上的原则对技术文档进行裁剪。不过，这种裁剪更适合那些技术文档无需严格遵循GJB438B的项目。

这正是：

文档编写多耗时，裁剪要求应实施

他山之石可攻玉，活学活用看实际

参考书目：Google软件测试之道，作者：(美)惠特克(Whittaker，J.)，(美)阿尔邦(Arbon，J)，(美)卡罗洛(Carollo，J)，译者：黄利，李中杰，薛明，出版社：人民邮电出版社