软件文档编写指南.pdf

软件文档编写指南--欢迎阅读软体文档编写指南封面格式：文档编号版本号文档名称：专案名称：专案负责人：编写年月日校对年月日审核年月日批准年月日开发单位系统规约说明书（SystemSpecification）一．引言A.文档的范围和目的B.概述1．目标2．约束二．功能和数据描述A.系统结构1．结构关系图2．结构关系图描述三．子系统描述A.子系统N的结构图规约说明B.结构字典C.结构连接图和说明四．系统建模和模拟结构A.用於模拟的系统模型B.模拟结果C.特殊性能五．软体专案问题A.软体专案可行性研究报告B.软体专案计画六．附录软体专案可行性研究报告（ReportforFeasibilityStudy）一．引言1．编写目的（阐明编写可行性研究报告的目的指出读者对象）2．专案背景（应包括：（1）所建议开发的软体名称；（2）专案的任务提出者、开发者、用户及实现单位；（3）专案与其他软体或其他系统的关系。）软件文档编写指南--软件文档编写指南--欢迎阅读3．定义（列出文档中用到的专门术语的定义和缩略词的原文。）4．参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．可行性研究的前提1．要求（列出并说明建议开发软体的基本要求如（1）功能；（2）性能；（3）输出；（4）输入；（5）基本的数据流程和处理流程；（6）安全与保密要求；（7）与软体相关的其他系统；（8）完成期限。）2．目标（可包括：（1）人力与设备费用的节省；（2）处理速度的提高；（3）控制精度和生产能力的提高；（4）管理资讯服务的改进；（5）决策系统的改进；（6）人员工作效率的提高等等。）3．条件、假定和限制（可包括：（1）建议开发软体运行的最短寿命；（2）进行系统方案选择比较的期限；（3）经费来源和使用限制；（4）法律和政策方面的限制；（5）硬体、软体、运行环境和开发环境的条件和限制；（6）可利用的资讯和资源；（7）建议开发软体投入使用的最迟时间。）4．可行性研究方法5．决定可行性的主要因素三．对现有系统的分析1．处理流程和数据流程2．工作负荷3．费用支出（如人力、设备、空间、支持性服务、材料等项开支。）4．人员（列出所需人员的专业技术类别和数量。）5．设备6．局限性（说明现有系统存在的问题以及为什麽需要开发新的系统。）四．所建议技术可行性分析1．对系统的简要描述2．处理流程和数据流程3．与现有系统比较的优越性4．采用建议系统可能带来的影响（1）对设备的影响（2）对现有软体的影响（3）对用户的影响（4）对系统运行的影响（5）对开发环境的影响（6）对运行环境的影响（7）对经费支出的影响5．技术可行性评价（包括：（1）在限制条件下功能目标是否能够达到；（2）利用现有技术功能目标能否达到；（3）对开发人员数量和品质的要求并说明能