《软件文档写作文档样张》由会员分享，可在线阅读，更多相关《软件文档写作文档样张（8页珍藏版）》请在金锄头文库上搜索。
1、软件编写指南封面格式：版本号文档名称：项目名称：项目负责人：编写年月日校对年月日审核年月日批准年月日开发单位系统规约说明书（SystemSpecification）引言文档的范围和目的概述目标约束功能和数据描述系统结构结构关系图结构关系图描述子系统描述子系统N的结构图规约说明结构字典结构连接图和说明系统建模和模拟结构用于模拟的系统模型模拟结果特殊性能软件项目问题软件项目可行性研究软件项目计划附录软件项目可行性研究（ReportforFeasibilityStudy）引言编写目的（阐明编写可行性研究报告的目的，指出读者对象）项目背景（应包括：（1）所建议开发的软件名称；（2）项目的任务提出者、开
2、发者、用户及实现单位；（3）项目与其他软件或其他系统的关系。）定义（列出文档中用到的专门术语的定义和缩略词的原文。）可行性研究的前提要求（列出并说明建议开发软件的基本要求，如（1）功能；（2）性能；（3）输出；（4）输入；（5）基本的数据流程和处理流程；（6）安全与保密要求；（7）与软件相关的其他系统；（8）完成期限。）目标（可包括：（1）人力与设备费用的节省；（2）处理速度的提高；（3）控制精度和生产能力的提高；（4）管理信息服务的改进；（5）决策系统的改进；（6）人员工作效率的提高，等等。）可行性研究方法决定可行性的主要因素对现有系统的分析处理流程和数据流程工作负荷费用支出（如人力、设备、
3、空间、支持性服务、材料等项开支。）人员（列出所需人员的专业技术类别和数量。）设备局限性（说明现有系统存在的问题以及为什么需要开发新的系统。）所建议技术可行性分析对系统的简要描述处理流程和数据流程与现有系统比较的优越性采用建议系统可能带来的影响对设备的影响对现有软件的影响对用户的影响对系统运行的影响对开发环境的影响对运行环境的影响对经费支出的影响技术可行性评价（包括：（1）在限制条件下，功能目标是否能够达到；（2）利用现有技术，功能目标能否达到；（3）对开发人员数量和质量的要求，并说明能否满足；（4）在规定的期限内，开发能否完成。）所建议系统经济可行性分析指出基建投资其他一次性支出经常性支出效益
4、一次性收益经常性收益不可定量收益收益/投资比投资回收周期敏感性分析（指一些关键性因素，如：系统生存周期长短、系统工作负荷量、处理速度要求、设备和软件配置变化对支出和效益的影响等的分析。）社会因素可行性分析法律因素（如，责任、侵犯专利权、侵犯版权等问题的分析。）用户使用可行性（如，用户单位的行政管理、工作制度、人员素质等能否满足要求。）其他可供选择的方案（逐个阐明其他可供选择的方案，并重点说明未被推荐的理由。）结论意见（可能是：（1）可着手组织开发；（2）需待若干条件（如资金、人力设备等）具备后才能开发；（3）需对开发目标进行某些修改；（4）不能进行或不必进行（如技术不成熟，经济上不合算等）；（
5、4）其他。）软件项目计划（SoftwareProjectPlan）引言编写目的（阐明编写软件计划的目的，指出读者对象。）项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。）产品名称：图书管理系统任务提出者：项目经理开发者：花儿与少年系统开发团队用户及产品实现单位：黑龙江外国语学院图书馆定义（列出本文档中用到的专门术语的定义和缩略词的原文。）PM(ProjectManager)-项目经理配置管理计划质量保证计划系统分析和设计二项目概述工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等.若不编写可行性研究报告,则应在本节给出较详细的介绍。)条
6、件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件.必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。）产品（1）程序（列出应交付的程序名称使用的语言及存储形式。）（2）文档（列出应交付的文档。）（3）运行环境（应包括硬件环境软件环境。）4服务（阐明开发单位可向用户提供的服务.如人员培训安装保修维护和其他运行支持。）验收标准实施计划任务分解（任务的划分及各项任务的负责人。）进度（按阶段完成的项目,用图表说明开始时间完成时间。）预算关键问题（说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明对策。）人员组织及分工交付期限专题计划要点（如
7、测试计划质量保证计划配置管理计划人员培训计划系统安装计划等。）需求规格说明书（RequirementsSpecification）引言编写目的（阐明编写需求说明书的目的,指明读者对象。）项目背景（可包括：（1）项目的委托单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）定义（列出文档中用到的专门术语定义和缩写词的原文。）任务概述目标运行环境条件与限制数据描述静态数据动态数据（包括输入数据和输出数据。）数据库描述（给出使用数据库的名称和类型。）数据词典数据采集功能需求功能划分功能描述性能需求数据精确度时间特性（如响应时间、更新处理时间、数据转化与传输时间、运行时间等。）适应性（在操作方式运行环境与其他软件的接口以及开发计划等发生变化时，应具有的适应能力。）运行需求用户界面（如屏幕格式、报表格式、菜单格式、输入输出时间等。）
