1、模版集萃综述在程序员的日常工作中，除了编写代码之外，还免不了需要编写各种技术文档。一个编写良好的技术文档在项目中能够很好地建立沟通与协作，起到很积极的作用。因此，编写技术文档也就成为了程序员技能提升的很重要的一面。为此，我们特意收集了一些在项目开发过程中经常用到的文档模板，这些模板包括格式和简单的写作说明，相信能够帮助大家编写出更加高效、实用的技术文档。在收集过程中，我们十分注重其实用性，以确保每个模板的价值，而且对于一些重要的文档提供了多个模板。为了方便大家查找，我们将收录的 57 模板分为以下几类：项目及开发管理类：包括立项前的分析，立项后的计划、以及进度跟踪、风险控制方面的文档模板，共计
2、 16 个；需求分析类：明确清晰的需求，是项目成功的基础，在此收集了在需求分析过程中所将使用到的文档模板，共计 14 个；系统分析与设计类：包括体系结构设计、高层设计、详细设计、数据库设计等 6 个相关文档模板；软件质量保证类：软件测试是质量保证的关键活动，在此收集了软件测试相关的 11 个文档模板；其它类：除此之外，还收集了关于用户手册、软件维护等方面的 10 个文档模板，其中还有一个软件过程规范的示例。另外，值得说明的是，文档模板只是为文档的编写提供一个基础，在实际的编写过程中，你可以根据自己的需要进行必要的剪裁和增补。一、项目及开发管理类1.1 可行性研究报告(ISO 标准)编者说明：在
3、立项时，应该对项目进行综合分析，探讨项目的经济、社会、技术可行性，从而为决策提供基础。该模板为 ISO 标准文档模板，其不仅适用于软件项目，对于其它的系统项目也适用。1. 引言1.1 编写目的编写本可行性研究报告的目的，指出预期的读者。1.2 背景a.所建议开发的软件系统的名称；b.本项目的任务提出者、开发者、用户及实现该软件的计算站或计算机网络；c.该软件系统同其他系统或其他机构的基本的相互来往关系。1.3 定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4 参考资料列出用得着的参考资料。2. 可行性研究的前提说明对所建议开发的软件的项目进行可行性研究的前提。2.1 要求说
4、明对所建议开发的软件的基本要求。2.2 目标说明所建议系统的主要开发目标。2.3 条件、假定和限制说明对这项开发中给出的条件、假定和所受到期的限制。2.4 进行可行性研究的方法说明这项可行性研究将是如何进行的，所建议的系统将是如何评价的，摘要说明所使用的基本方法和策略。2.5 评价尺度说明对系统进行评价时所使用的主要尺度。3. 对现有系统的分析这里的现有系统是指当前实际使用的系统，这个系统可能是计算机系统，也可能是一个机械系统甚至是一个人工系统。分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。3.1 处理流程和数据流程说明现有系统的基本的处理流程和数据流程。此流程可
5、用图表即流程图的形式表示，并加以叙述。3.2 工作负荷列出现有系统所承担的工作及工作量。3.3 费用开支列出由于运行现有系统所引起的费用开支。3.4 人员列出为了现有系统的运行和维护所需要的人员的专业技术类别和数量。3.5 设备列出现有系统所使用的各种设备。3.6 局限性列出本系统的主要局限性。4. 所建议的系统4.1 对所建议系统的说明概括地说明所建议系统，并说明在第 2 条中列出的那些要求将如何得到满足，说明所使用的基本方法及理论根据。4.2 处理流程和数据流程。给出所建议系统的处理流程式和数据流程。4.3 改进之处按 2.2 条中列出的目标，逐项说明所建议系统相对于现存系统具有的改进。4
6、.4 影响说明新提出的设备要求及对现存系统中尚可使用的设备须作出的修改。4.4.1.对设备的影响说明新提出的设备要求及对现存系统中尚可使用的设备须作出的修改4.4.2.对软件的影响说明为了使现存的应用软件和支持软件能够同所建议系统相适应，而需要对这些软件所进行的修改和补充。4.4.3.对用户单位机构的影响说明为了建立和运行所建议系统，对用户单位机构、人员的数量和技术水平等方面的全部要求。4.4.4.对系统运行过程的影响说明所建议系统对运行过程的影响。4.4.5.对开发的影响说明对开发的影响。4.4.6.对地点和设施的影响说明对建筑物改造的要求及对环境设施的要求。4.4.7.对经费开支的影响扼要
7、说明为了所建议系统的开发，统计和维持运行而需要的各项经费开支。4.5 技术条件方面的可能性本节应说明技术条件方面的可能性5. 可选择的其他系统方案扼要说明曾考虑过的每一种可选择的系统方案，包括需开发的和可从国内国外直接购买的，如果没有供选择的系统方案可考虑，则说明这一点。5.1 可选择的系统方案 1说明可选择的系统方案 1，并说明它末被选中的理由。 5.2 可选择的系统方案 2按类似 5。1 条的方式说明第 2 个乃至第 n 个可选择的系统方案。6. 投资及效益分析6.1 支出对于所选择的方案，说明所需的费用，如果已有一个现存系统，则包括该系统继续运行期间所需的费用。6.1.1 基本建设投资包
8、括采购、开发和安装所需的费用。6.1.2 其他一次性支出 6.1.3 非一次性支出列出在该系统生命期内按月或按季或按年支出的用于运行和维护的费用。6.2 收益对于所选择的方案，说明能够带来的收益，这里所说的收益，表现为开支费用的减少或避免、差错的减少、灵活性的增加、动作速度的提高和管理计划方面的改进等，包括：6.2.1 一次性收益说明能够用人民币数目表示的一次性收益，可按数据处理、用户、管理和支持等项分类叙述。6.2.2 非一次性收益说明在整个系统生命期内由于运行所建议系统而导致的按月的、按年的能用人民币数目表示的收益，包括开支的减少和避免。6.2.3 不可定量的收益逐项列出无法直用人民币表示
9、的收益。6.3 收益/投资比求出整个系统生命期的收益/投资比值。6.4 投资回收周期求出收益的累计数开始超过支出的累计数的时间。6.5 敏感性分析是指一些关键性因素与这些不同类型之间的合理搭配、处理速度要求、设备和软件的配置等变化时，对开支和收益的影响最灵敏的范围的估计。7. 社会因素方面的可能性7.1.法律方面的可行性7.2.使用方面的可行性8. 结论在进行可行性研究报告的编制时，必须有一个研究的结论Comment XuFeng1: 页：6注，改写自 RUP模板中的商业理由1.2 软件项目商业性分析编者说明：随着市场经济的不断发展，一个项目的商业价值、市场价值往往是衡量项目价值的最大依据。该
10、文档模板十分适用于产品型项目，当你提出一个新的产品开发方向时，一份商业性分析是说服管理层的一个很好工具。当然，如果是一些内部项目，也是可以借鉴该文档模板来论证该项目的商业价值。1. 文档概述该部分主要描述该文档的目的、范围、术语以及参考资料等方面的内容。1.1 目的说明该文档的作用。1.2 范围简要说明该与文档相关的其它事物与资料。1.3 术语列出所有将出现于本文档的新术语、缩略语等。1.4 参考资料在此应列出项目计划中引用的文档列表，对于引用的每个文档都应该列出其标题、文档编号、日期，并且指出这些文档的来源，以方便该计划的阅读者查找。1.5 概述本小节说明该文档所包括的内容，以及它的组织方式
11、。2.系统说明在此简要地说明将要开发的系统，包括其名称、系统所解决的问题以及它的开发价值等，从而使得读者能够有一个直接的了解。并且在这处还应列出与在本文档中出现的缩略词的解释，以便读者更好地阅读。3.业务环境这一小节主要说明要开发的系统所处于的业务环境。它包括系统所面向的领域、用户。也可以在此指出它是产品型项目，还是用户定制型项目，同时如果该项目与原有的项目有紧密的联系，在此也应该把这些联系列出来。4.产品目标这一小节则用于深入说明为什么要开发该系统，它有什么价值。最好还应对进度计划、进度风险做一些评估。一个明确确定、表述清晰、可以度量的目标将为今后系统的开发工作打下坚实的基础。 5. 财务预
12、测如果是产品型项目，那么其输出就是一个商业软件产品。对于这样的项目，在此应该包括对该项目的财务预测，最主要应该得出投资回报（ROI）指标。在做 ROI 分析时，应该针对不同的完成时间做出不同的预测，以让系统开发者对于进度延迟对投资回报的损伤有一个直观的了解。在财务预测中，有一个基点就是对项目工作量、资源使用的估算，在这里还应给出估算的基础技术，当然这里的估算会随着项目的进展而逐步精化，应该这里还是应该估算出一个合理的范围。6. 约束任何事有利就有弊，在本小节则主要列举执行该项目时会遇到的一个诸如外部接口、标准、认证、特殊的技术等约束，这些约速将会对项目带来很大的执行风险，可能对项目的成本也带来
13、巨大的影响。1.3 软件开发项目立项表编者说明：在许多开发组织中，开发立项请求通常来自市场部门，该表格的设计就是为了更好地理顺两个部门之间的沟通与协调，也使得开发立项流程化，你可以根据自己公司的实际情况，对该表格的格式做一些修改。项目名称(暂定)：项目编号（开发部填写）：项目申请人： 申请日期：项目优先级： 最迟完成时间：问题/机会：项目目标及成功标准：目标描述：假设、风险及障碍：客户名单：项目提出人：项目决策人：项目相关人员：审批人意见：签名： 日期：1.4 软件项目计划(ISO 标准)编者说明：拿破仑说过：“没有一场战役是按照计划打的，而胜利的战役没有一个是没有计划的。”，战役尚且如此，软
14、件项目也不例个。一个经过周密考虑，团队协作共同制订的项目计划是成功的关键。本文档模板是 ISO 标准模板，虽然时间有点久远，但还是十分有参考价值的。1. 引言1.1 编写目的说明编写这份项目开发计划的目的，并指出预期的读者。1.2 背景a.待开发软件系统的名称；b.本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络；c.该软件系统同其他系统或其他机构的基本的相互来往关系。1.3 定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4 参考资料列出用得着的参考资料。2. 项目概述2.1 工作内容简要地说明在本项目的开发中须进行的各项主要工作。 2.2 主要参加人员
15、扼要地说明参加本项目开发工作的主要人员的情况，包括他们的技术水平。2.3 产品2.3.1 程序 列出需移交给用户的程序的名称、所用的编程语言及存储程序的媒体形式，并通过引用有关文件。逐项说明其功能和能力。2.3.2.文件 列出需移交给用户的每种文件的名称及内容要点。2.3.3.服务列出需向用户提供的各项服务。 2.3.4.非移交的产品 说明开发集体应向本单位交出但不必向用户移交的产品。 2.4 验收标准 对于上述这些应交出的产品和服务，逐项说明或引用资料说明验收标准。2.5 完成项目的最迟期限2.6 本计划的批准者和批准日期3. 实施计划3.1 工作任务的分解与人员分工对于项目开发中需完成的各
16、项工作，从需求分析、设计、实现、测试直到维护，包括文件的编制、审批、打印、分发工作，用户培训工作，软件安装工作等，按层次进行分解，指明每项任务的负责人和参加人员。3.2 接口人员说明负责接口工作的人员及他们的职责。3.3 进度对于需求分析、设计、编码实现、测试、移交、培训和安装等工作，给出每项工作任务的预定的开始日期、完成日期及所需资源，规定各项工作任务完成的先后顺序以及表征每项工作任务完成的标志性事件。3.4 预算逐项列出本开发项目所需要的劳务以及经费的预算和来源。3.5 关键问题逐项列出能够影响整个项目成败的关键问题、技术难点和风险，指出这些问题对项目的影响。4.支持条件说明为支持本项目的开发所需要的各种条件和设施。4.1 计算机系统支持逐项列出开发中和运行时所需的计算机系统支持，包括计算机、外围设备、通讯设备、模拟器、编译程序、操作系统、数据管理程序包、数据存储能力和测试支持能力等，逐项给出有关到货日期、使用时间的要求。4.2 需由用户承担的工作逐项列出需要用户承担的工作和完成期限，包括需由用户提供的条件及提供时间。4.3 需由外单位提供的条件逐项列出需要外单位分合同承包者承担的工作和完成的时间。5.专题计划要点说明本项目开发中需制订的各个专题计划的要点。
