文档质量审核

来自TC WIKI
跳到导航 跳到搜索

自我审核(Self review)

必须有的自审环节。技术文档工程师每次写好一个版本甚至一个部分的文档,首先要做的就是自己检查。

同行审核(Peer review)

文档通过自我审核之后,技术文档工程师需要找同一组或同一公司的同行来评审。除非公司只有一名技术文档工程师,否则这个审核环节也是必须要有的。

大纲审核(TOC review)

对于一个新开发的文档或者重新组织架构的文档,目录/大纲的确立是后面一切工作的根本。

格式审核(Format review)

主要检查格式排版等是否符合要求。如果有现成的模板,本审核环节就不是必须的。或者有些文档开发项目里并没有单独的格式审核,而是和其它类型的审核合并在一起了。

术语审核(Lexicon review)

针对术语的检查,一般适用于未建立起术语库或术语不一致性的产品或文档项目。

信息级别审核(Information level review)

文档语言难易程度的审核。例如,最终用户手册和开发人员手册的难易程度一定不同。

图片审核(Illustration review)

图片质量的审核,尤其对于图片要求高、工作量大、外包定制等情况尤为必要。同时,还要有配套的评审标准和流程。

技术审核(Technical review)

最重要的审核之一,也往往是技术文档工程师对文档内容更改最多的一个审核环节,用来确保文档中技术信息和描述的准确性和完整性。一般由研发和测试来审核、提供审核意见、补充素材等,大多时候要至少安排两轮。

语言审核(Editorial review)

此审核只针对文档中的拼写、语法、句型、表达等基本问题,对于英文文档,一般由母语人士或英语能力接近母语人士的中国人来负责。

验证(Verification)

通过对产品进行实际操作,来验证文档技术方面的准确性,因此也可以认为它是技术审核的一种。

最终审核(Final review)

文档最终交付前质量控制的最后一关。如果之前的那些审核已经做得很全面细致(建议应当如此),那么最终审核可能就是交付前的总体检查,多数情况下没有其它审核意见或意见几乎为零。

印前审核(Pre-printing review)

有些文档交付后还要印刷,因此可能还需要提供文档的印刷版本,提供前也要审核一下。