关于编程文档模板,编程文档模板怎么做这个很多人还不知道,今天小乐来为大家解答以上的问题,现在让我们一起来看看吧!
编程文档模板 编程文档模板怎么做
1、软件需求文档格式的标准写法1.引言1.1 编写目的· 阐明开发本软件的目的;1.2 项目背景· 标识待开发软件产品的名称、代码;· 列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展工作直接有关的人员和用户;· 说明该软件产品与其他有关软件产品的相互关系。
2、1.3 术语说明列出本文档中所用到的专门术语的定义和英文缩写词的原文。
3、1.4 参考资料(可有可无)列举编写软件需求规格说明时所参考的资料,包括项目经核准的计划任务书、合同、引用的标准和规范、项目开发计划、需求规格说明、使用实例文档,以及相关产品的软件需求规格说明。
4、在这里应该给出详细的信息,包括标题、作者、版本号、发表日期、出版单位或资料来源。
5、2.项目概述2.1 待开发软件的一般描述描述待开发软件的背景,所应达到的目标,以及市场前景等。
6、2.2 待开发软件的功能简述待开发软件所具有的主要功能。
7、为了帮助每个读者易于理解,可以使用列表或图形的方法进行描述。
8、使用图形表示,可以采用:· 顶层数据流图;· 用例UseCase图;· 系统流程图;· 层次方框图。
9、2.3 用户特征和水平(是哪类人使用)描述最终用户应具有的受教育水平、工作经验及技术专长。
10、2.4 运行环境描述软件的运行环境,包括硬件平台、硬件要求、操作系统和版本,以及其他的软件或与其共存的应用程序等。
11、2.5 条件与限制给出影响开发人员在设计软件时的约束条款,例如:· 必须使用或避免使用的特定技术、工具、编程语言和数据库;· 硬件限制;· 所要求的开发规范或标准。
12、3.功能需求3.1 功能划分列举出所开发的软件能实现的全部功能,可采用文字、图表或数学公式等多种方法进行描述。
13、3.2 功能描述对各个功能进行详细的描述。
本文到这结束,希望上面文章对大家有所帮助。