Book & Man

Software, Design, Investment

编写优秀的文档:技术文档风格

未评论,抢沙发!

Python软件框架Django的作者Jacob Kaplan-Moss接上一篇“技术文档:写什么”帖子,继续探讨如何培养能帮你写出优秀的技术文档的写作风格。

Learn to write
Unfortunately, there aren’t any shortcuts here. The best way to learn how to write great documentation is to first learn how to write (anything). There are some important differences between technical documentation and your average prose, but a solid foundation of good written communication skills is an irreplaceable prerequisite.
So how do you learn to write (anything) well? There’s only one answer: you’ll learn to write well if you write. A lot.

学习写作

很不幸,写作没有任何捷径可走。学习如何编写优秀的文档的最好方法首先就是学习如何写作(写任何内容)。技术文档和你平时普通的写作主题有一些重要的区别,但是,书面沟通技能方面的坚实基础是不可替代的前提条件。

那么,怎样才能学会如何写作(写任何内容)呢?答案只有一个:如果要让自己变得能写,你就是要不断地写,大量地写。

英文原文

作者: Chuancy

日期:2009-11-19 at 10:34 下午

分类: General

关键词: , ,

Leave a Reply