8.4 文档

完成一个可交付结果需要经历一些步骤,如下图所示。第一步是项目评审。在这个环节中服务提供商会评审工作说明书、客户商业目标、需要斟酌的地方以及预期能提供的价值。所有这些再加上一些额外的可引起共鸣的材料,就构成了一个报告模板。

下一步是在信息收集环节填写报告模板。收集到的信息包括识别的设备、采用的流程、发现的漏洞、漏洞的验证、建议的修复以及其他数据。

在所有数据被收集并跟模板对齐后,第三步是准备第一版草稿。这份草稿不会是呈现在客户面前的那份,它包含了尽可能多的信息。最后一步是审定过程,将报告精简到只包含最可靠的数据,以及对系统做哪些调整可以满足业务需要。最佳实践是让专业技术人员和专业写作人员一起编辑这份草稿,保证其既能满足业务运营需求,又能满足技术人员的需求。

你制定的工作范围一定要包含创建文档所需的时间。通常报告写作时间中60%的时间都用于完成初稿,文档审定以及项目交付会占用剩下的时间。你要确保将文档生命周期计入项目时间表来避免收益受损。