每个公司都需要自己专有的 Writing Style Guide 吗?不!

每个公司都需要Writing Style Guide来规范技术写作吗?
Dan:嗯,我认为是的。一个公司的技术文档,特别是面向客户的产品文档,很大程度上体现了一个公司的专业性。如果没有一个统一的Writing Style Guide作为指导,不同的技术文档作者在写作的时候就没有统一的规范,也就不能保证写作风格的一致性。最终呈现在用户面前的就可能是一份格式和表达不一,显得很不专业的产品手册。如果是几个作者合作同时为一个产品开发文档,就更需要有一个Writing Style Guide来进行规范了。

那么,每个公司都需要编写和维护属于自己公司的Writing Style Guide吗?
Dan:这个……我觉得,不需要。

为什么呢?前面不是说Writing Style Guide很重要吗?
Dan:呃,之所以这么说,是因为我认为使用Writing Style Guide最主要的目的是保证文档写作风格的一致性,因此只要达到这个目的就够了。说实话,比如我不认为会有很多人在乎甚至是注意到我们文档的标题用的是Title Case还是Sentence Case。而我们需要做的是保证文档章节的标题在同样的情况下不会有时是Title Case,有时又是Sentence Case,这样就足够了,这就是我强调的一致性。
因此,要达到一致性这个主要目的,最简单的方法就是使用市面上已有的,公开出版的Writing Style Guide,比如Microsoft Manual of Style for Technical Publications (MSTP),或者IBM的Style Guide。这些Style Guide涵盖的内容已经很丰富了,包括了技术写作中可能会遇到的各种写作风格的问题,已经足够了。使用公开出版的Writing Style Guide而不是自己编写Writing Style Guide,还可以给我们带来不少好处。

还有什么好处,可以说得具体点吗?
Dan:在我看来,直接使用公开出版的Writing Style Guide的好处包括下面几点。

  • 不需要有专人或者专门的Writing Style Comittee来开发和维护公司的Writing Style Guide,节约成本。现在大多数公司都在控制成本,许多公司现在配备的Technical Writer也越来越少,所以大家还是把我们有限的时间去做更重要的事情吧。编写和维护Writing Style Guide的事情,就交给有钱有精力的公司去做吧。
  • 新人可以更快开始工作,减少培训所需的时间。这些公开出版的Writing Style Guide,已经被许多公司用来作为参考和学习,所以很有可能你新招聘的Technical Writer对于这些Writing Style Guide已经都比较熟悉了。
  • 这些Writing Style Guide,比如MSTP,内容很全面。其中的一些章节也许你现在还用不到,但是以后可能会用到,比如对机器翻译的考虑等。


可是,没有自己Writing Style Guide,我们就不能按照自己的想法来更新Style Guide了?
Dan:呃,现实中的情况是,有人想要去改某个Writing Style,然后大家花时间和精力去讨论和实施,可是基本上最后的结论或者说结局其实大都只个人的喜好选择而已,很少是真正能够为用户和读者带来什么很大的益处。
如果实在觉得有必要对某些Guideline进行修改,可以在使用公开出版的Writing Style Guide的基础上,附加一个自己公司对某些Style特殊要求的文档就可以了,也完全不需要再重新编写一份Writing Style Guide。

 

(以上均为作者的自问自答@#¥¥%%……囧)

 

1 条评论 次浏览

  1. Vicky 的头像 Vicky 说:
    哈哈,可爱。
    Dan 于 2017/06/06 15:10:55 回复
    你更可爱~

留下评论/回复