测试文章

137 阅读1分钟

技术文档要符合以下要求:

1.针对性

文档编制以前应分清读者对象,按不同的类型、不同层次的读者,决定怎样适应他们的需要。

① 对于面向管理人员和用户的文档,不应像开发文档(面向软件开发人员)那样过多地使用软件的专业术语。 难以避免使用的词汇,应在文档中添加词汇表,进行解释。

② 开发文档使用的专业词汇未被广泛认知的,应添加注释进行说明。

③ 缩写词未被广泛认知的,应在其后跟上完整的拼写。

2.正确性

① 没有错字,漏字。

② 文档间引用关系正确。

③ 文档细节(Title/History)正确。

3.准确性

① 意思表达准确清晰,没有二义性。

② 正确使用标点符号,避免产生歧义。

4.完整性

① 意思表达完整,能找到主语、谓语、宾语,没有省略主语,特别是谓语。

② 一句话中不能出现几个动词一个宾语的现象。

③ 不遗漏要求和必需的信息。