原型说明书模板.docxVIP

.

.

;.

;.

概要

原型说明书模板

原型规范 //关于本原型的特殊规范

功能一览 //所有功能点清单

模块结构 //功能模块的结构关系

业务术语 //解释原型界面上的一些专业术语

···· //如果团队或某项目有需要特定的说明的，可以添加

总体要求与规则

统一要求 //全局性的要求

主要算法 //介绍主要算法

共用规则 //在某些功能点中用到的相同规则

···· //如果团队或某项目有需要特定的说明，可以添加

功能模块1

功能点 // 下面的内容可以按模块、子模块的层级划分章节

功能点1 //详细说明每个功能点的业务需求A 主要功能

主要用户

主场景

权限

功能需求

操作1

E1.1 操作1.1

····

操作2

····

规则

重用规则

数据字典

实体1

表1-1数据字典

字段

字段

取值范围

特殊要求

事例

备注

实体2

····

注意事项

功能点2

···· //功能点可以有很多

子功能点 //被多个功能点调用的子功能点

子功能点1

子功能点2

····

特殊功能点

调度任务 //定时自动执行的功能点

调度任务1

主要功能说明

执行方法C算法逻辑D其他说明

····

接口//开放给其他系统调用的功能点

接口1

主要功能说明

入参

算法逻辑

返回

其他说明

····

功能模块2

····

这个模板主要分为三大部分：第一部分，是对设计出来的原型进行概要性的描述，目的是让阅读者对原型有个概略了解，从而为理解整个软件设计打下基础；第二部分，描述全局性的要求、规则等，将各个功能点中使用到的相同的规则、或者有很强关联性的规则提炼出来放在这里，目的是降低对规则理解的难度，减少文档的编写工作量，提高文档的可维护性；第三部分，分模块说明需求。第三部分又包括对三种功能点的描写：功能点——对每个功能点进行详细描述，这是原型说明书的重心，每个功能点又包括主要功能、主要用户、主场景、功能需求等8个子项，其中，“功能需求”需要对所有的操作逻辑进行描述，是这部分的核心，也是整个文档的重中之重；子功能点——描述会被其他功能点调用的子功能；特殊功能点——描述一些特殊的功能点，如定时执行的调度任务、开放给第三方调用的接口等，如果有其他的特殊功能点，可以追加。

应注意的是，原型说明书（包括其他软件文档）的编写方式并没有一定之规，不同的团队、不同的项目可以有不同的文档撰写方法，可以设计自己的文档模板、编写规范。完全可以根据自己的项目特点、团队的工作特点设计自己的文档体系。