软件文档的编制及辅助工具的设计.pdfVIP

( ) 第 24卷第 4 期 郑州航空工业管理学院学报 社会科学版 Vo l. 24 No. 4 2005年 8月 Journal of Zhengzhou In stitute of A eronautical Indu stry M anagem en t ( Social Science Edition) 2005. 8 软件文档的编制及辅助工具的设计 王红霞 (郑州航空工业管理学院 ,河南 　郑州 　450015) 摘 　要 : 软件文档在软件的设计 、开发和维护的过程中都发挥着极其重要的作用 ,软件文档的标准化及软 件文档的编制工作也备受广大软件开发人员关注 。文章对软件文档的重要性进行分析 ,并提出 了一个软件文档辅助工具的设计方案 。 关键词 :软件文档 ;文档模板 ;文档要素 ; DCCA SE工具 中图分类号 : TP3 11. 5　　文献标识码 : C　　　文章编号 : 1009 - 1750 (2005) 04 - 0 154 - 02 　　在软件工程中 ,文档常常用来表示对活动 、需求 、过程 人员工作的准则和规程 。它们基于软件生存期方法 ,把软 或结果进行描述 、定义 、规定 、报告或认证 。它们描述和规 件产品从形成到最后被淘汰的整个过程应提交的文档归于 定了软件设计和实现的细节 ,说明使用软件的操作命令 。 13种 :可行性报告 、项 目开发计划 、软件需求说明书 、数据 文档也是软件产品的一部分 ,没有文档的软件就不称其为 要求说明书 、概要设计说明书 、详细设计说明书 、用户手册 、 软件 。 操作手册 、测试计划 、测试分析报告 、开发进度月报 、项 目开 软件文档的编制在软件开发过程中占有突出的地位和 发总结报告 、维护修改建议 。 相当的工作量 ,它伴随着软件开发过程中的活动而产生 ,贯 这些文档可以用自然语言编制 ,也可以使用表格 、图形 穿软件的整个生命周期 ,所以高效率 、高质量的开发 、管理 编制 ,或者用计算机系统 自动产生 ,但它们必须是可阅读 和维护文档对于充分发挥软件产品的效益有着重要的意 的。 义 。 二 、文档的编制 一 、软件文档的分类 软件文档起到指导软件项 目进展和帮助人员交流的作 按照文档产生的范围 ,软件文档大致可分为如下 3类 : 用 ,但每个人的思维习惯 ,交互方式和工作态度都各不相 1. 开发文档 同 ,这样每个人写出的文档就可能五花八门,需要从这些文 这类文档是在软件开发过程中产生的 ,作为软件开发 档中获取信息的人员 ,要习惯和接受文档编制人员的个性 人员前一阶段工作成果的体现和后一阶段工作的依据 。包 化信息表达方式 ,对于计划性和信息精确性要求很高的软 括软件需求说明书 、数据要求说明书 、概要设计说明书 、详 件项 目开发 ,这样的交互方式是不可思议的。这就要求软 细设计说明书 、可行性研究报告和项 目开发计划 。 件文档 ,必须遵循一种很好的公共标准 ,在这种标准下 ,什 2. 管理文档 么是完整的 ,什么是对的 ,什么是必须做的 ,都是非常明确 这类文档是在软件开发过程中 , 由软件开发人员制定 的。 的 ,需提交人员的一些工作计划或工作报告 。管理人员能