软件工程常用文档模板及示例:项目计划、需求分析、概要设计、详细设计、用户操作手册、测试计划、测试分析报告、开发进度报告、项目开发总结报告、软件维护手册等.
本文链接提供设计阶段的饿相关文档模板:
去下载模板https://rwq.lanzout.com/igEJa1iwq7mh
文件如下:
数据库设计说明书
功能设计说明书
功能设计说明书,需求文档
文档状态 | 保密级别 | |
[ √ ]草稿 [ ]修订 [ ]发布 | 文档编号 | |
管理部门 | ||
修订年月 | ||
版本号 |
XXX项目
功能设计说明书
修订人签字 | 审核人签字 | 批准人签字 |
日期: | 日期: | 日期: |
变更履历
序号 | 变更日期 | 版本 | 变更位置 | 变更原因 | 修订人 | 审核人 | 批准人 |
1 | |||||||
说明:“变更原因”主要是分为:
- 建立初稿
- 内容修订
- 正式发布
目录
说明文档的编写目的
说明文档的主要内容
说明文档的读者对象
术语或缩写 | 解释 |
序号 | 文档名称 | 文档编号 | 版本 | 发布日期 |
1 | ||||
2 |
介绍系统的名称、任务提出者、开发者、用户群
介绍项目的背景,在什么样的背景下产生该产品
介绍产品的目标与愿景,产品要能满足什么样的需求,要达到什么样一个效果
描述产品的整体需求,产品要能满足什么需求,要达到什么效果
描述产品的功能性需求,产品要包含哪些功能或者服务接口。首先要指定需求的编号规则,然后按照规则对功能性需求进行模块划分和编号,最后要对每一个需求进行详细描述
描述需求的编号规则
描述需求的模块划分情况
模块名称 | |||||
模块简介 | |||||
模块功能列表 | |||||
序号 | 一级功能 | 二级功能 | |||
功能名称 | 功能编号 | 功能名称 | 功能编号 | ||
1 | |||||
2 | |||||
3 | |||||
4 |
描述本功能
-
-
-
- 二级功能1编号
-
-
描述本功能
-
-
-
- 二级功能2编号
-
-
描述本功能
描述本功能
-
-
-
- 二级功能1编号
-
-
描述本功能
-
-
-
- 二级功能2编号
-
-
描述本功能
模块名称 | |||||
模块简介 | |||||
模块功能列表 | |||||
序号 | 一级功能 | 二级功能 | |||
功能名称 | 功能编号 | 功能名称 | 功能编号 | ||
1 | |||||
2 | |||||
3 | |||||
4 |
描述本功能
-
-
-
- 二级功能1编号
-
-
描述本功能
-
-
-
- 二级功能2编号
-
-
描述本功能
描述本功能
-
-
-
- 二级功能1编号
-
-
描述本功能
-
-
-
- 二级功能2编号
-
-
描述本功能
功能列表或图示
功能列表或图示
说明
- 页面迁移图
图示
- 页面截图
截图
说明
- 页面迁移图
图示
- 页面截图
截图
数据库设计
文档状态 | 保密级别 | |
[√]草稿 [ ]修订 [ ]发布 | 文档编号 | |
管理部门 | ||
修订年月 | ||
版本号 |
XXX系统项目
数据库设计说明书
修订人签字 | 审核人签字 | 批准人签字 |
日期: | 日期: | 日期: |
变更履历
序号 | 变更日期 | 版本 | 变更位置 | 变更原因 | 修订人 | 审核人 | 批准人 |
1 | |||||||
说明:“变更原因”主要是分为:
- 建立初稿
- 内容修订
- 正式发布
本说明书说明 “XXX系统”的数据库设计、结构情况,用于开发人员进行项目设计,同时也为后续的数据库维护工作提供了良好的使用说明,也可以作为未来版本升级时的重要参考资料。
该文档主要包含了系统数据库的详细设计,如系统数据库系统,设计工具,数据库配置,数据库命名规范,数据表结构定义,数据库逻辑设计,数据库物理设计。
本文档主要面向公司高级管理员,项目管理员,开发工程师,质量管理人员,测试人员。
术语或缩写 | 解释 |
SD | 系统设计,System Design。说明本数据库将反映的现实世界中的实体、属性和它们之间的关系等的原始数据形式,包括各数据项、表、视图、存储过程、触发器的标识符、定义、类型、度量单位和值域,建立本数据库的每一幅用户视图。 |
序号 | 文档名称 | 文档编号 | 版本 | 发布日期 |
1 | 《XXX系统-需求规格说明书》 | V1.0 | ||
2 | 《XXX系统-功能策划说明书》 | V1.0 |
Oracle 10g
PowserDisinger
表空间 | LNG |
表空间初始化大小 | 500M |
自增量 | 10M |
用户名 | LNG |
密码 | LNG |
命名须以LNG_开头
命名必须清晰
命名必须易懂
命名不应太长
命名要尽量提供有意义的信息
命名要提取关键字。如: 用户信息表:LNG _USER
命名必须清晰
命名必须易懂
命名不应太长
命名要尽量提供有意义的信息
字段名 | 描述 | 数据类型 | 是否主键 | 备注 |
EVENTID | 图纸ID | NVARCHAR2(38) | PK | |
BlueprintTypeID | 图纸类型ID | NVARCHAR2(38) | FK | |
BlueprintName | 图纸名称 | NVARCHAR2(25) | ||
BluprintForm | 图纸格式 | NVARCHAR2(50) | ||
BlueprintYear | 图纸年份 | DATE | ||
Note | 备注 | NVARCHAR2(200) | ||
InsertUserName | 创建人名称 | NVARCHAR2(25) | ||
InsertDate | 创建日期 | DATE | ||
AlertUserName | 修改人名称 | NVARCHAR2(25) | ||
AlertDate | 修改日期 | DATE | ||
DateState | 数据状态 | SMALLINT |
无
根据以上逻辑设计关系,得到以下表。
- create table LNG_BLUEPRINT
(
EVENTID NVARCHAR2(38) not null,
BLUEPRINTTYPEID NVARCHAR2(38),
BLUEPRINTNAME NVARCHAR2(25) not null,
BLUPRINTFORM NVARCHAR2(50),
BLUEPRINTYEAR DATE,
NOTE NVARCHAR2(200),
INSERTUSERNAME NVARCHAR2(25),
INSERTDATE DATE,
ALERTUSERNAME NVARCHAR2(25),
ALERTDATE DATE,
DATESTATE INTEGER
)