(需求分析+概要设计+详细设计)文档简单范例

软件开发文档项目名： “通讯录”版本： α测试版作者： ccba编写时间：2001-8-20文档内容：1 需求规格说明书2 概要设计说明书3 详细设计说明书文档号IM00101需求规格说明书1、引言：1.1 编写目的本文档的编写是为了确定待开发软件的功能、性能、数据、界面的需求。

1.2 项目背景“通讯录”软件是为了提供一种功能完备，易于操作、界面美观的优秀软件。

该软件由蔡文亮单独开发完成。

1.3 定义需求规格说明书采用参考资料②标准1.4 参考资料①薛华成《管理信息系统（第三版）》清华大学出版社1999.5②郑人杰、殷人昆、陶永雷《实用软件工程（第二版）》清华大学出版社1997.4③周之英《现代软件工程（基本方法篇）》科学出版社 2000.12、功能需求该软件由四个主功能模块和一个扩展功能模块构成，各功能模块中规定的均为软件的基本功能，在开发过程中，开发人员可根据实际情况在满足基本功能需求的前提下增加新功能，但必须详细编写相关文档。

2.1录入、修改功能模块该功能块主要用于数据库的数据录入和修改，考虑到通讯录的实际需要，可以放松对数据库完整性结束的控制，但从减少数据库的角度来考虑，不容许有完全相同的纪录出现（考虑的合并，相同的纪录项）。

2.2查询功能块本功能模块是最重要的功能块，对通讯录的操作最主要部分就是查询操作。

本功能块要求有如下功能：1）按数据库各个属性查询2）按数据库各个属性之间的逻辑组合查询如：查询名称为“鸭子”且年龄为20岁的详细情况（SQL语句表示）SELECT *FROM MESSAGERWHERE NICKNAME=“鸭子”AND AGE=203）按某一属性的数值范围查询及其逻辑组如：查询年龄在20至35岁间的详细情况（SQL语句表示）SELECT *FROM MESSAGERWHERE AGE BETWEEN 20 AND 354）模糊查询同时我们要求查询结果可以按用户要求的格式来显示，如：用户能调整显示属性的个数和组合。

2.3系统安全块通讯录的信息是个人隐私，故在软件中加入必要的安全措施。

主要有以下三点：1）登录帐号和密码的管理2）帐户权限的控制3）对部分登录帐号隐藏部分内容2.4系统设置块本部分内容主要是对软件使用时一些设置使其更利于软件的使用：主要包括以下四个方面：1）系统界面背景和色彩设置（模仿WINNAP）2）闹铃功能开关，即实现朋友生日提醒功能3）记录内容项（即数据库修改通讯录上的内容项）4）历史记录，用户可以选择是否记录下何人何时使用过该软件2.5扩展功能块1）网络功能：通过OLE/COM接口的调用，实现E-mail软件调用。

2）帮助文档的制作（On-line help）3、性能需求3.1效率需求：要求软件的启动时间不超过3秒，最好控制在2秒内，每次查询的时间不超过3秒，其它各项操作完成时间在1秒限内。

3.2空间需求：视数据库大小而定，一般在10M以内。

4、数据描述4.1E-R图4.2数据项数据项：姓名含义说明：标识记录信息别名：无类型：字符串长度： 20取值范围：中文字符或西文字符与其他数据项的逻辑关系：允许重名现象数据项：系统色彩标志位含义说明：系统是否有色彩设置别名：无类型：布尔型取值含义：T是 F否与其他数据项的逻辑关系：若系统有色彩设置，启用系统色彩数据数据项：系统色彩含义说明：系统界面色彩别名：无与其他数据项的逻辑关系：若系统有色彩设置，启用系统色彩数据数据项：系统背景标志位含义说明：系统是否有背景设置别名：无类型：布尔型取值含义：T是 F否与其他数据项的逻辑关系：若系统有背景设置，启用系统背景数据数据项：系统背景含义说明：系统界面背景别名：无类型：长整形与其他数据项的逻辑关系：若系统有背景设置，启用系统背景数据数据项：系统提醒功能开关含义说明：系统是否有提醒功能设置别名：无类型：布尔型数据项：系统跟踪审计功能开关含义说明：系统是否有跟踪审计功能设置类型：布尔型数据项：系统权限矩阵含义说明：不同权限级别的权限设置类型： 4×4布尔型矩阵数据项：出生日期含义说明：记录项表示的人物的出生日期类型：日期型数据项：性别含义说明：记录项表示的人物的性别取值说明： T男 F女数据项：联系方式含义说明：记录项表示的人物的联系方式数据项：账号别名：用户账号含义说明：用户登录系统使用的身份鉴别码类型：字符串长度： 10取值范围：数字、中文字符和西文字符与其他数据项的逻辑关系：和密码数据项一一对应数据项：密码别名：用户密码含义说明：用户用于登录系统的和用户账号相应的密码类型：字符串长度： 10取值范围：数字、中文字符和西文字符与其他数据项的逻辑关系：和账号数据项一一对应数据项：权限含义说明：用户账号的权限类型：短整形与其他数据项的逻辑关系：权限矩阵用于设置本数据项4.3数据结构数据结构：系统数据含义说明：记录系统的设置数据组成：系统数据结构=系统色彩标志位+系统色彩+系统背景标志位+系统背景+系统提醒功能开关+系统跟踪审计功能开关+系统权限矩阵数据结构：记录项数据含义说明：记录通信录中的记录信息组成：记录项数据结构=姓名+性别+年龄+联系方式数据结构：用户数据含义说明：用户登录系统使用数据组成：用户数据=账号+密码+权限4.4数据流4.5数据存储注：4.数据流 5.数据存储略4.6主题数据库①记录主数据库存储记录项数据②安全数据库存储用户账号、密码、权限信息③系统数据库存储系统数据4 历史记录数据库存储软件使用的历史情况5、运行需求5.1 用户界面简洁明快、造型新颖、有用户设置功能5.2 硬件接口I/O设备：显示器、打印机、鼠标、键盘5.3 故障处理显示故障信息，有一定自动纠错功能6、安全需求应提供基本的安全控制，包括：账户密码控制、用户权限控制、跟踪审计控制文档号IM00102概要设计说明书1、引言：1.1 编写目的概要设计是为了说明系统的功能分配，模块划分，程序的总体结构，输入输出及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。

1.2 项目背景该项目由信息管理系九八级学生蔡文亮同学单独开发，拟在作为软件分发出去。

1.3 定义本说明书中业务流程图（TFD）采用薛华成的《管理信息系统（第三版）》 p.339标准。

1.4 参考资料①薛华成管理信息系统（第三版）清华大学出版社1999.5②需求规格说明书文档号IM00101③郑人杰、殷人昆、陶永雷《实用软件工程（第二版）》清华大学出版社，1997.42、任务概述2.1 目标：作为一个简便易用的自由软件2.2 运行环境：WINDOWS 95/98/ME/NT/2000Paradox 数据库管理系统硬件环境：1BM-PC机，笔记本电脑2.3 开发方案：利用Borland C++ Builder 5.0单独完成试用版的开发工作。

3、总体设计3.1 处理流程（如图1）另：系统启动时有登录过程，登录成功后有系统的配置过程。

3.2 总体结构和模块外部设计为方便阅读，现将软件的总体结构图示如下：（如图2）尤其拟用RAD（Rapid Application Development）BCB进行开发，故各模块之间功能相对独立，各模块共用的数据有记录数据库、安全数据库和系统数据。

4、接口设计4.1 外部接口用户界面：用户界面要求较活泼，符合小软件的风格。

软件接口：无硬件接口：无特殊硬件接口，用户采用键盘、显示器、鼠标作为主要设备，查询结果也可用打印机输出。

4.2 内部接口各模块之间并无直接的通信关系，通过系统数据来传递信息。

5、数据结构设计本系统中自行定义的数据结构是系统数据作用是描述系统设置，其逻辑结构和含义如下：（用类C语言描述）Class SystemData{//系统数据定义bool ColorFlag；//是否用缺省的配置 T不用F用long SColor；//用户有定义色彩bool PictureFlag；//是否使用背景图案 T是F否char SPicture[100]；//背景图案位置bool Alarm；//提醒功能开关 T开 F关bool Record；//跟踪审计功能开关 T开 F关bool Grant [4] [4]；//权限矩阵 T有权限 F无权限};该数据结构的物理设计从略该数据结构记录系统设置系统启动时使用,系统设置以及安全设置模块对其修改6、运行设计6.1 运行模块的组合该系统采用事件驱动思想，要求各模块间事件执行，严格并执行系统及两个以上的模块。

6.2 运行控制各模块的运行采用事件驱动的方式，在WINDOWS主控窗体（本系统中称之为控制面板）的控制下，由事件驱动运行。

7、出错处理本系统中，出错主要是由于数据库操作失误引起软件运行出错，其它出错可能不大，故出错处理只是简单的WINDOWS风格的告知窗口，并由系统处理出错情况。

8、安全保密设计在软件的一级采用帐号密码、权限控制、审计跟踪（可选）三种方式进行安全保密。

文档号IM 00103详细设计说明书1、引言1.1 编写目的：在概要设计的条件下，继续工作，为编码人员提供编码依据，同时也会测试维护人员提供依据。

1.2 项目背景作为自由软件的一个项目。

1.3 定义本文档格式按参考资料①P.4831.4 参考资料①郑人杰、殷人昆、陶永雷《实用软件工程（第二版）》清华大学出版社 1997.4②需求规格文档说明书文档号IM00101③详细设计说明书文档号IM001022、总体设计2.1 要求概述2.2软件结构3、程序描述3.1 录入修改功能模块3.1.1功能：对记录数据库进行插入和修改操作3.1.2性能：要求对响应：响应时间不超过1秒3.1.3 输入项目：①原始数据②修改信息3.1.4输出项目：①完成信息②出错信息3.1.5 并法无特殊并法3.1.6 程序逻辑3.1.7接口：用户界面设计3.1.8测试要点：①对输出信息是否及时输出，输出内容是否正确的测试②对输入信息的完整性约束条件的测试3.2 查询模块3.2.1功能：根据用户给出条件查询记录Drs中的信息，显示查询结果，并可打印查询结果3.2.2性能：①查询过程不超过2秒钟，尽量缩短查询时间②给出适当的出错控制3.2.3输入项目①查询条件②查询系统3.2.4输出项目查询结果、报表3.2.5并法无特殊并法3.2.6程序逻辑3.2.7接口界面设计3.2.8测试要点①SQL语句生成机构的健壮性，是否会产生不可执行的SELECT语句，引起查询失败，系统出错。

②报表生成机构是否会显示查询的手段。

3.3安全设置模块3.3.1功能:①登录帐号和密码程序②帐户权限的范围控制③控制是否隐蔽部分内容注:本功能模块只允许admin帐号以及admin授权帐号管理Ⅰ、帐号密码：每用户均需一注册的帐号及相应密码进行登录，系统有管理员帐号admin，初始密码是123456。