Archive for the ‘Consistency’ Category

技术写作里的 En Dash 和 Em Dash

2013年9月2日

一致性(Consistency)是技术写作里最重要的原则之一。即使是标点符号,也应保证其使用的一致性。

小小的横线,使用上也有区别。这里说的横线也就是 En Dash 和 Em Dash。

虽然这是技术写作里很基础的东西,还是在博客里记录一下,算是一个备忘吧。

...

术语管理在技术文档写作中的重要性

2013年6月1日

今天看了Content Rules上的一篇whitepaper,标题是"Shepherding Your Content for Operational Efficiency"。这篇文章详细阐述了术语管理(Terminology Management)对于提高文档写作效率和提高内容效用的重要性,并给出了应该如何进行术语管理的建议。

Graphic - Shepherding Your Content for Operational Efficiency

的确,从我个人的经验来看,许多公司在文档写作中对于术语或者说是用词用语的管理,真的就像文中所说一样,通过Word或者Excel来维护一个词汇列表,又或者是把它加入到公司所谓的style guide中并加上使用说明。

问题出现了,大家真的会经常查看这样术语列表吗?

...