文件名称:软件技术文档撰写要求
文件大小:38KB
文件格式:DOC
更新时间:2012-12-28 07:31:04
撰写要求
软件技术文档撰写要求文档 文档编制以前应分清读者对象,按不同的类型、不同层次的读者,决定怎样适应他们的需要。 ① 对于面向管理人员和用户的文档,不应像开发文档(面向软件开发人员)那样过多地使用软件 的专业术语。 难以避免使用的词汇,应在文档中添加词汇表,进行解释。 ② 开发文档使用的专业词汇未被广泛认知的,应添加注释进行说明。 ③ 缩写词未被广泛认知的,应在其后跟上完整的拼写。