技术写作技术文档写作

美国老编谈Topic-Based Writing (I)

2017-05-08  本文已影响27人  Joy的未来十年

Topic-based Writing说来接触它有十来年了:

有了上述做保障,topic-based writing难点就突显在如何将内容任务化、粒度、深度。 即便是同一类读者,也可以分Novice, intermedia, advanced几等。Writer在学习到TBW理论知识后,还需要平时多去研究大公司经典文档的写作方法。我个人很欣赏Adobe DreamWaver的Getting Started Guide。把这份大文档保存在电脑上,不时拿出来学习、效仿、揣摩。

当时组里刚招到一个资深编辑Utpala Unand。Utpala是一个有着20多年技术写作的Writer,近几年转而做Tech Editor。当初我也参与她的面试,与她电话1小时,相谈甚欢,很多问题上有着共鸣。为此,我让她帮列出了美国可供学习的TBW手册,以及她对TBW的经验与实际操作方法。(有兴趣的同学,可上LinkedIn搜索并加她关注)

For a pure topic-based-authoring ( TBA) approach, look at the following:

Microsoft IIS 6.0 Documentation

Note: TBA examples are only for you to understand how documentation is being very specific to each topic/task and to see examples of how to weave concept, task and reference together.

For the remaining content, please visit 美国老编谈Topic-Based Writing (II) at http://www.jianshu.com/p/3686ec580e6a.
.

上一篇下一篇

猜你喜欢

热点阅读