软件文档编写指南new

《软件文档编写指南new》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、软件文档编写指南目录封面格式：.................................................................................................2系统规约说明书（SystemSpecification）..............................................3软件项目可行性研究报告（ReportforFeasibilityStudy）...................4软件项目计划（SoftwareProjectPlan）................

2、.................................6需求规格说明书（RequirementsSpecification）....................................7概要设计说明书（ArchitecturalDesignSpecification）.........................8详细设计说明书（ProceduralDesignSpecification）............................9用户操作手册（UserGuide）.................................

3、...............................10测试计划（TestPlan）............................................................................12测试分析报告（TestSpecification）......................................................13开发进度月报.............................................................................

4、..............14项目开发总结报告...................................................................................15软件修改报告...........................................................................................161/16软件文档编写指南封面格式：文档编号版本号文档名称：项目名称：项目负责人：编写年月日校对年月日审核年月日批准年月日开发单位-2-软件文档编写指南系统规约说明

5、书（SystemSpecification）一．引言A.文档的范围和目的B.概述1．目标2．约束二．功能和数据描述A.系统结构1．结构关系图2．结构关系图描述三．子系统描述A.子系统N的结构图规约说明B.结构字典C.结构连接图和说明四．系统建模和模拟结构A.用于模拟的系统模型B.模拟结果C.特殊性能五．软件项目问题A.软件项目可行性研究报告B.软件项目计划六．附录-3-软件文档编写指南软件项目可行性研究报告（ReportforFeasibilityStudy）一．引言1．编写目的（阐明编写可行性研究报告的目的，指出读者对象）2．项目背景（应包括：（1）所建议开发的软件名称

6、；（2）项目的任务提出者、开发者、用户及实现单位；（3）项目与其他软件或其他系统的关系。）3．定义（列出文档中用到的专门术语的定义和缩略词的原文。）4．参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．可行性研究的前提1．要求（列出并说明建议开发软件的基本要求，如（1）功能；（2）性能；（3）输出；（4）输入；（5）基本的数据流程和处理流程；（6）安全与保密要求；（7）与软件相关的其他系统；（8）完成期限。）2．目标（可包括：（1）人力与设备费用的节省；（2）处理速度的提高；（3）控制精度和生产能力的提高；（4）管理信息服务的改进；（5）决策系

7、统的改进；（6）人员工作效率的提高，等等。）3．条件、假定和限制（可包括：（1）建议开发软件运行的最短寿命；（2）进行系统方案选择比较的期限；（3）经费来源和使用限制；（4）法律和政策方面的限制；（5）硬件、软件、运行环境和开发环境的条件和限制；（6）可利用的信息和资源；（7）建议开发软件投入使用的最迟时间。）4．可行性研究方法5．决定可行性的主要因素三．对现有系统的分析1．处理流程和数据流程2．工作负荷3．费用支出（如人力、设备、空间、支持性服务、材料等项开支。）4．人员（列出所需人员的专业技术类别和数量。）5．设备6．局限