软件技术文档撰写要求.doc

《软件技术文档撰写要求.doc》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、软件技术文档撰写要求2008-01-14作者:龚云卿来源:CSDN1针对性文档编制以前应分淸读者对象,按不同的类型、不同层次的读者,决定怎样适应他们的需要。%1对于面向管理人员和用户的文档，不应像开发文档(面向软件开发人员)那样过多地使用软件的专业术语。难以避免使用的词汇，应在文档中添加词汇表，进行解释。%1开发文档使用的专业词汇未被广泛认知的，应添加注释进行说明。%1缩写词未被广泛认知的，应在其后跟上完報的拼写。2止确性%1没有鉛字，漏字。%1文档间引用关系止确。%1文档细节(Title/Hi.story)正确。3准确

2、性%1意思表达准确清晰，没有二义性。%1止确使用标点符号，避免产生歧义。4完整性%1意思表达完整，能找到主语、谓语、宾语，没有省略主语，特别是谓语。%1一•句话中不能出现几个动词一个宾语的现象。%1不遗漏要求和必需的信息。5简洁性%1尽量不要采用较长的句子來描述，无法避免吋，应注意使用止确的标点符号。%1简洁明了，不累赘冗余，每个意思只在文档中衣达一次。%1每个陈述语句，只表达一个意思。%1力求简明，如有可能，陀以适当的图表，以增强其清晰性。6统一性%1统一采用专业术语和项目规定的术语集。%1同一个意思和名称，前后描述的

3、用语要一致。%1文档前后使用的字体要统一。%1同一课题若干文档内容应该协调一致，没有矛盾。7易读性%1文字描述要通俗易懂。%1前后文关联词使用恰当。%1文档变更内容用其他颜色与上个版本区别开来。%1测试步骤要采用列表的方式，用1）、2）、3）…等数字序号标注。