因为技术写作相对来说仍属于一种创作,不同的作者因此完全有可能呈现出截然不同的作品;但从另一个角度来说,技术写作又并不是一个可以由得创作者自由发挥的过程,有许多规范和要求必须予以严格遵循,以确保最终的产品能满足实际的需要。特别重要的一点就是,很多时候的技术写作并非是一个完全从头开始的过程,而极有可能是在以前的内容上的改进与更新,在这种情形下,还需确保与之前内容的一致性,。大体上,在全新内容与旧有内容的处理上,技术文档的撰写有一些通用的准则。
1、全新内容的写作
由于技术文档通常是由一个小组合作完成的,因此会由一个资深的技术作者进行统一协调,通常来说,如果某位作者被分配负责某一部分内容,则其对该部分的内容具有全面的决定权,任何对于该内容的创作、修改与更新,都应由该作者负责。毫无疑问,作者有义务去仔细查看所有的相关资料,对产品进行足够的调研,并与客户尤其是客户方面的技术专家进行必要的讨论,从而获得创作内容所必须的相应知识。
2、旧有内容的处理
当技术写作是在旧有内容的基础上进行时,便涉及对旧有内容的处理,很多作者都会不由自主地对旧内容进行适当的修改,以便使之符合自己的风格,而这个恰恰是修改旧有内容的大忌。
对旧有内容的随意更改会引发很多不可预期的问题,典型的情形是,由于许多旧有内容此前都已近进行了本地化,任何的修饰都会招致额外的本地化工作量,由此带来成本的急剧上升。
总的来说,技术文档的撰写是一切本地化及全球化工作能得以顺利进行的基础,遵循标准的流程和规范,应用正确的工具和方法,是高水准的技术文档写作的基本保证。