模版集萃
综述
在程序员的日常工作中,除了编写代码之外,还免不了需要编写各种技术文档。一个编写良好的技术文档在项目中能够很好地建立沟通与协作,起到很积极的作用。因此,编写技
术文档也就成为了程序员技能提升的很重要的一面。
为此,我们特意收集了一些在项目开发过程中经常用到的文档模板,这些模板包括格式
和简单的写作说明,相信能够帮助大家编写出更加高效、实用的技术文档。在收集过程中,我们十分注重其实用性,以确保每个模板的价值,而且对于一些重要的文档提供了多个模板。
为了方便大家查找,我们将收录的57模板分为以下几类:
项目及开发管理类:包括立项前的分析,立项后的计划、以及进度跟踪、风险控制方面的文档模板,共计16个;
需求分析类:明确清晰的需求,是项目成功的基础,在此收集了在需求分析过程中所将使用到的文档模板,共计 14个;
系统分析与设计类:包括体系结构设计、高层设计、详细设计、数据库设计等6个相关文档模板;
软件质量保证类:软件测试是质量保证的关键活动,在此收集了软件测试相关的11个文档模板;
其它类:除此之外,还收集了关于用户手册、软件维护等方面的10个文档模板,其中
还有一个软件过程规范的示例。
另外,值得说明的是,文档模板只是为文档的编写提供一个基础,在实际的编写过程中,
你可以根据自己的需要进行必要的剪裁和增补。
一、项目及开发管理类
1.1可行性研究报告(ISO标准)
编者说明:
在立项时,应该对项目进行综合分析,探讨项目的经济、社会、技术可行性,从而为决策提供基础。该模板为ISO标准文档模板,其不仅适用于软件项目,对于其它的系统项目
也适用。
1. 引言
1.1编写目的
[编写本可行性研究报告的目的,指出预期的读者。]
1.2背景
a. [所建议开发的软件系统的名称;]
b. [本项目的任务提出者、开发者、用户及实现该软件的计算站或计算机网络;]
c. [该软件系统同其他系统或其他机构的基本的相互来往关系。]
1.3定义
[列出本文件中用到的专门术语的定义和外文首字母组词的原词组。]
1.4参考资料
[列出用得着的参考资料。]
2. 可行性研究的前提
[说明对所建议开发的软件的项目进行可行性研究的前提。]
2.1要求
[说明对所建议开发的软件的基本要求。]
2.2目标
[说明所建议系统的主要开发目标。]
2.3条件、假定和限制
[说明对这项开发中给出的条件、假定和所受到期的限制。]
2.4进行可行性研究的方法
[说明这项可行性研究将是如何进行的,所建议的系统将是如何评价的,摘要说明所使用的基本方法和策略。]