项目技术文档格式样板

项目编号：←（宋体小4号）
项目名称←（黑体小初，不超过25字
需求文档模板
↑
（宋体小1号）
↑
（宋体四号）
深圳市xx科技信息有限公司
↑
（宋体四号）
变更记录
↑
（宋体四号）
目录
1.概述4
1.1 项目背景←（节标题宋体小三号加粗）4
1.2 开发背景4
1.3 领域描述4
1.4 术语定义4
2. 功能描述5
2.1功能列表5
2.2 系统功能结构图 5
2.3 模块功能说明6
2.3.1 XX功能（功能模块名称）←（条标题宋体四号加粗）6
3. 非功能性需求8
3.1并发数；8
3.2响应速度；8
3.3 数据传输；8
4. 接口说明9
4.1硬件接口9
4.2软件接口9
（目录最多不超过3级标题、目录编号统一为阿拉伯数字、单倍行距，宋体四号，前后缩进 1.0cm）
1.概述
（章标题宋体三号加粗,数字Times New Roman）
1.1 项目背景←（节标题宋体小三号加粗）
<简要描述项目的背景、意义、目的、目标等> ←（正文宋体小四号）
1.2 开发背景
<为什么要做这个产品，在什么环境开发产品>
1.3 领域描述
<说明项目涉及到的业务背景>
例：项目类似人力资源管理系统，主要包括信息管理、考勤、劳动合同等几个模块。

1.4 术语定义
2. 功能描述
2.1功能列表
表2-1 XXX功能列表 （表名及表内容：宋体五号）
( 图表上下与文中文字间需留一空行编排)
（图表中表头的背景色统一成灰3，字体加粗）
2.2 系统功能结构图
<插入流程图：Pencil软件> ( 英文：Times New Roman,12pt)
<流程图能直观地描述一个工作过程的具体步骤，能准确描述事情是如何进行的，以及需要决策的步骤> ↑
(说明：插图之前，文中必须有关于本插图的提示，如“见图1-1”、“如图1-1所示”等。

各级标题后面不可直接插图。

)
(结构图由上至下逐模块细化)
2.3 模块功能说明
2.3.1XX功能（功能模块名称）←（条标题宋体四号加粗）
（1）功能描述←（正文中的序号不能再用“1、2、……”而用“(1)、(2)……”，更下一级别用“①、②……”或“(a)、(b)”等；）
<描述具体功能，实现目标，应用场景>
（2）模块流程图
<描述模块操作流程>
1.（3）用例图
<用例场景插图，Astah软件>
（4）用例场景
<描述用例执行者、前置条件、后置条件、基本路径、业务规则、约束条件>参考用例格式如下：
用例名称：
执行者：<操作人员>
前置条件：<启动该用例之前的系统状态>
后置条件：<约束用例执行后的系统状态>
基本路径：<描述该用例的操作流程，正常流程（主流程、分支流程）、异常流程>
预期结果：<描述执行该用例后的预期结果>
业务规则：<功能角度出发的规则，描述业务上的约束，它们规定了满足什么条件后业务将如何反应>
约束条件：<设计角度出发的约束，如用例中的计算公式和约束限制等>
（5）画面迁移图
<描述原型图与原型图之间的迁移关系>
(6) 原型图
<插入原型图，Axure RP Rro7.0软件>
<原型图能详细展示产品功能点分布、页面布局、页面跳转关系，如页面跳转复杂，可绘制单独的线框图进行说明。

另外，描述页面上相关的字段，而不是操作字段。

>
( a. 图、表与其题注需要在同一页，不能分页显示；
b.分图编号用“a)、b)”，各分图同页；
c.图、表编号正确、连续；
d.同一页不够表示时，在下一页采用“表3-1（续表）”的形式；)
（绘制原型图时尽可能简单，只罗列功能，无需考虑UI）
<原型图需要有界面项目说明，格式如下表>
※<项目的补充说明>
3. 非功能性需求
3.1并发数；
3.2响应速度；
3.3 数据传输；
4. 接口说明
<简要说明该软件同其他软件之间的公共接口、数据通信协议等，如果外部接口仅与某子功能有关，该接口说明应列在子功能规格说明书中。

>
4.1硬件接口
处理器要求：
运行环境：
内存要求：
4.2软件接口
操作系统平台：
开发语言：
开发工具：
<其他注意事项>
1、文档要美观，图片大小要适当调整，有必要时换页显示
2、文档整理好后更新目录
3、业务术语要统一。