软件工程文档模板好的开发文档就是别人一拿到你的文档就可以接着你的工作往下写程序,而不要挖空心思去想你的程序是什么结构,怎么写的。
下面给出通常软件工程文挡模板供大家参考:============================================================New Project 1: 需求分析说明书============================================================1. 引言1.1. 编写目的1.2. 背景说明1.3. 术语定义1.4. 参考资料2. 任务概述2.1. 目标2.2. 用户的特点2.3. 假定与约束3. 需求规定3.1. 对功能的规定3.2. 对性能的规定3.2.1. 精度3.2.2. 时间特性要求3.2.3. 灵活性3.3. 输入输出要求3.4. 数据管理能力要求3.5. 故障处理要求3.6. 其它专门要求4. 运行环境设定4.1. 设备4.2. 支持软件4.3. 接口4.4. 控制5. 缩写词表6. 参考文献============================================================New Project 1: 总体设计说明书============================================================1. 前言2. 摘要3. 需求分析3.1. 企业生产经营概况3.2. 企业经营目标及策略(近期及远期)3.3. 实施需求3.4. 实施目标3.5. 实施约束3.6. 实施功能要求3.7. 实施信息要求3.8. 实施性能要求4. 总体方案与结构4.1. 制定总体结构的出发点4.2. 体系结构4.3. 应用系统结构4.4. 支撑系统结构4.5. 信息分类编码体系5. I2DEF模型5.1. 模型选择说明5.2. I2DEF模型设计规范5.3. 结构模型5.3.1. 系统/功能分解树5.3.2. 构件图5.4. 动态模型5.4.1. 事件流程图5.4.2. 事件汇总图5.4.3. 工作案例图5.4.4. 典型事件跟踪图5.5. 功能模型5.5.1. 数据流程图5.5.2. 数据汇总图5.5.3. 功能调用图6. 资源需求7. 系统配置7.1. 配置原则7.2. 硬件配置7.3. 软件配置8. 接口8.1. 内部接口8.2. 外部接口9. 组织机构及人员配置9.1. 现行组织机构9.2. 开发运行的组织机构9.3. 人员配置与培训10. 关键技术10.1. 关键技术的提出10.2. 关键技术的一般说明10.3. 关键技术的实现方案11. 方案实施的技术路线和实施计划11.1. 实施的技术路线11.2. 实施计划12. 投资概算及资金规划12.1. 投资概算12.2. 资金规划13. 经济分析13.1. 经济效益分析13.2. 财务评价分析13.3. 社会效益、战略效益分析13.4. 经济评价的结论和建议14. 缩写词表15. 参考文献============================================================ New Project 1: 详细设计说明书============================================================1. 前言2. 摘要3. 系统详细需求分析3.1. 详细需求分析3.1.1. 详细功能需求分析3.1.2. 详细性能需求分析3.1.3. 详细信息需求分析3.1.4. 详细资源需求分析3.1.5. 详细组织需求分析3.1.6. 详细系统运行环境及限制条件需求分析3.1.7. 信息要求3.1.8. 性能要求3.2. 接口需求分析3.2.1. 系统接口需求分析3.2.2. 现有软、硬件资源接口需求分析3.2.3. 引进软、硬件资源接口需求分析4. 总体方案设计4.1. 系统总体结构4.1.1. 系统组成、逻辑结构4.1.2. 应用系统结构4.1.3. 支撑系统结构4.1.4. 系统集成4.1.5. 系统工作流程4.2. 分系统详细界面划分4.2.1. 应用分系统与支撑分系统的详细界面划分4.2.2. 应用分系统之间的界面划分5. 应用分系统详细设计5.1. XX分系统详细需求分析5.1.1. 功能详细需求分析5.1.2. 性能详细需求分析5.1.3. 信息详细需求分析5.1.4. 限制条件详细分析5.2. XX分系统结构设计及子系统划分5.3. XX分系统功能详细设计5.4. 分系统界面设计5.4.1. 外部界面设计5.4.2. 内部界面设计5.4.3. 用户界面设计6. 数据库系统设计6.1. 设计要求6.2. 信息模型设计6.3. 数据库设计6.3.1. 数据访问频度和流量6.3.2. 数据库选型6.3.3. 异构数据库的连接与数据传递方式6.3.4. 逻辑结构设计6.3.5. 数据共享方式设计6.3.6. 数据安全性及保密设计6.3.7. 数据字典设计7. 网络通信系统设计7.1. 设计要求7.2. 网络结构设计7.2.1. 网络选型7.2.2. 网络互连设计7.2.3. 网络协议7.2.4. 信息载体和硬件配置7.3. 网络布局设计7.3.1. 网络的物理布局设计7.3.2. 网络实施要求8. 信息编码设计8.1. 代码结构设计8.2. 代码编制9. 关键技术9.1. 关键技术的提出9.2. 关键技术的一般说明9.3. 关键技术的实现方案10. 系统配置10.1. 硬件配置10.2. 软件配置11. 限制12. 组织机构及人员配置12.1. 机构调整与确认12.2. 组织机构的任务和职责12.3. 人员配置方案12.4. 培训计划13. 工程实施计划13.1. 分期实施内容13.2. 进度计划13.3. 实施条件13.4. 测试与验收14. 投资预算15. 参考和引用资料16. 术语============================================================ New Project 1: 用户手册============================================================1. 前言2. 摘要3. 需求分析3.1. 企业生产经营状况3.2. 经营目标及采取的策略3.3. 建立CIMS的必要性3.4. CIMS目标3.5. 建立CIMS的约束3.6. 对CIMS的功能要求3.7. 对CIMS的信息要求3.8. 对CIMS的性能要求4. 总体方案与结构4.1. 制定总体结构的出发点4.2. 体系结构4.3. 应用系统结构4.4. 支撑系统结构4.5. 信息分类编码体系5. I2DEF模型5.1. I2DEF建模方法选择说明5.2. I2DEF建模规范5.3. 系统结构模型5.3.1. 系统/功能分解树5.3.2. 构件图5.4. 系统动态模型5.4.1. 事件流程图5.4.2. 事件汇总图5.4.3. 工作案例图5.4.4. 典型事件跟踪图5.5. 系统功能模型5.5.1. 数据流程图5.5.2. 数据汇总图5.5.3. 功能调用树6. 系统配置6.1. 配置原则6.2. 硬件配置6.3. 软件配置7. 接口7.1. 内部接口7.2. 外部接口8. 组织机构及人员配置8.1. 现行组织机构8.2. CIMS开发运行的组织机构8.3. 人员配置与培训9. 关键技术9.1. 关键技术的提出9.2. 关键技术的一般说明9.3. 关键技术的实现方案10. 方案实施的技术路线和实施计划10.1. 实施的技术路线10.2. 实施计划11. 投资概算及资金规划11.1. 投资概算11.2. 资金规划12. 经济分析12.1. 经济效益分析12.2. 财务评价分析12.3. 社会效益、战略效益分析12.4. 经济评价的结论和建议13. 缩写词表14. 参考文献====================================================================== ====一、可行性研究报告====================================================================== ====1,引言1.1 编写目的1.2 项目背景1.3 定义{列出本文档中用到的专门术语的定义和缩写词的原文。
}1.4 参考资料{列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:a.本项目经核准的计划任务书、合同或上级机关的批文;b.与本项目有关的已发表的资料:c.本文档中所引用的资料,所采用的软件标准或规范。
}2.可行性研究的前提2.1 要求{列出并说明建议开发软件的基本要求,如a.功能;b.性能;c.输出;d.输人;e.基本的数据流程和处理流程;f.安全与保密要求;g.与本软件相关的其它系统;h.完成期限。
}2.2 目标{可包括:a.人力与设备费用的节省;b.处理速度的提高;e.控制精度或生产能力的提高;d.管理信息服务的改进;e.决策系统的改进;f.人员工作效率的提高等等。
}2.3 条件、假定和限制【可包括:a.建议开发软件运行的最短寿命;b.进行系统方案选择比较的期限;c.经费来源和使用限制;d.法律和政策方面的限制;e.硬件、软件、运行环境和开发环境的条件和限制;f.可利用的信息和资源;g.建议开发软件投人使用的最迟时间。
】2.4 可行性研究方法2.5 决定可行性的主要因素3. 对现有系统的分析3.1 处理流程和数据流程3.2 工作负荷3.3 费用支出{如人力、设备、空间、支持性服务、材料等项开支。
}3.4 人员{列出所需人员的专业技术类别和数量。
}3.5 设备3.6 局限性{说明现有系统存在的问题以及为什么需要开发新的系统。
}4.所建议技术可行性分析溜4.1 对系统的简要描述4.2 处理流程和数据流程4.3 与现有系统比较的优越性4.4 采用建议系统可能带来的影响4.4.1对设备的影响4.4.2对现有软件的影响4.4.3对用户的影响4.4.4对系统运行的影响4.4.5对开发环境的影响4.4.6对运行环境的影响4.4.7对经费支出的影响4.5 技术可行性评价{包括:a.在限制条件下,功能目标是否能达到;b利用现有技1术,功能目标能否达到;c.对开发人员数量和质量的要求,并说明能否满足;d.在规定的期限内,开发能否完成。
}5.所建议系统经济可行性分析5.1 支出5.1.1 基建投资5.1.2 其它一次性支出5.1.3 经常性支出5.2 效益5.2.1 一次性收益5.2.2 经常性收益5.2.3 不可定量收益5.3、收益/投资比5.4 投资回收周期5.5 敏感性分析{敏感性分析是指一些关键性因素,如:系统生存周期长短、系统工作负荷量、处理速度要求、设备和软件配置变化对支出和效益的影响等的分析。