项目技术文档格式样板

项目编号：←（宋体小4号）项目名称←（黑体小初，不超过25字需求文档模板

↑（宋体小1号）文件编号：生效日期：

编制：

日期：审核：日期：批准：日期：

↑（宋体四号）深圳市xx科技信息有限公司

↑（宋体四号）变更记录日期版本变更说明作者YYYY-MM-DD1.0初始版本XX

↑

（宋体四号）

目录1.概述41.1项目背景←（节标题宋体小三号加粗）41.2开发背景41.3领域描述41.4术语定义42.功能描述52.1功能列表52.2系统功能结构图

52.3模块功能说明62.3.1XX功能（功能模块名称）←（条标题宋体四号加粗）63.非功能性需求83.1并发数；83.2响应速度；83.3数据传输；84.接口说明94.1硬件接口94.2软件接口9

↑

（目录最多不超过3级标题、目录编号统一为阿拉伯数字、单倍行距，宋体四号，前后缩进

1.0cm）1.概述

（章标题宋体三号加粗,数字TimesNewRoman）1.1项目背景←（节标题宋体小三号加粗）

<简要描述项目的背景、意义、目的、目标等>

←（正文宋体小四号）

1.2开发背景

<为什么要做这个产品，在什么环境开发产品>1.3领域描述

<说明项目涉及到的业务背景>

例：项目类似人力资源管理系统，主要包括信息管理、考勤、劳动合同等几个模块。1.4术语定义2.功能描述2.1功能列表

表2-1XXX功能列表

←（表名及表内容：宋体五号）序号模块名称业务需求扩展业务需求1<记述客户原始需求>23...↑(图表上下与文中文字间需留一空行编排)（图表中表头的背景色统一成灰3，字体加粗）2.2系统功能结构图

<插入流程图：Pencil软件>

←(英文：TimesNewRoman,12pt)

<流程图能直观地描述一个工作过程的具体步骤，能准确描述事情是如何进行的，以及需要决策的步骤>

↑(说明：插图之前，文中必须有关于本插图的提示，如“见图1-1”、“如图1-1所示”等。各级标题后面不可直接插图。)

(结构图由上至下逐模块细化)2.3模块功能说明

2.3.1XX功能（功能模块名称）←（条标题宋体四号加粗）（1）功能描述←（正文中的序号不能再用“1、2、……”而用“(1)、(2)……”，更下一级别用“①、②……”或“(a)、(b)”等；）

<描述具体功能，实现目标，应用场景>（2）模块流程图<描述模块操作流程>（3）用例图

<用例场景插图，Astah软件>（4）用例场景

<描述用例执行者、前置条件、后置条件、基本路径、业务规则、约束条件>

参考用例格式如下：

用例名称：执行者：

<操作人员>前置条件：<启动该用例之前的系统状态>后置条件：<约束用例执行后的系统状态>基本路径：<描述该用例的操作流程，正常流程（主流程、分支流程）、异常流程>预期结果：<描述执行该用例后的预期结果>业务规则：<功能角度出发的规则，描述业务上的约束，它们规定了满足什么条件后业务将如何反应>约束条件：<设计角度出发的约束，如用例中的计算公式和约束限制等>（5）画面迁移图

<描述原型图与原型图之间的迁移关系>

(6)原型图

<插入原型图，AxureRPRro7.0软件>

<原型图能详细展示产品功能点分布、页面布局、页面跳转关系，如页面跳转复杂，可绘制单独的线框图进行说明。另外，描述页面上相关的字段，而不是操作字段。>

↑

(

a.图、表与其题注需要在同一页，不能分页显示；

b.分图编号用“a)、b)”，各分图同页；

c.图、表编号正确、连续；

d.同一页不够表示时，在下一页采用“表3-1（续表）”的形式；)（绘制原型图时尽可能简单，只罗列功能，无需考虑UI）<原型图需要有界面项目说明，格式如下表>行号项目类型长度I/O必须备注1画面项目名项目类型TextButtonNumberCheckbox...I:输入O:输出必须输入项？Y/N对当前项目的补充说明，太长影响美观的情况下用※标注，在表格下方具体描述23※<项目的补充说明>3.非功能性需求3.1并发数；3.2响应速度；3.3数据传输；4.接口说明

<简要说明该软件同其他软件之间的公共接口、数据通信协议等，如果外部接口仅与某子功能有关，该接口说明应列在子功能规格说明书中。>4