软件文档写作注意点

不需要把问题的来龙去脉写的很清楚，也就是不需要起因、发展、情节；
专业术语必须有解释部分；
尽量使用短句；
对文档做好章节编排，编制好章节号；
章节名称必须能够概括本章节的主要内容，以便按章节名称查找信息；
注意文档定义的读者，考虑读者对于文档相关内容的必须背景的了解；

文档必须及时更新，以确保内容不是错误的，与当前的实际相符合；
 
注意：软件文档是应用文的一种，需要有应用文的特点：
1、特定的对象和写作目的
2、有较为固定的写作格式
3、有较强的时效性；
4、语言要朴实、简明、准确
 
另外并不是每个人的行文能力都达到了写出好文档的水平，但是都是可以培养的，更何况软件文档有固定的格式。