项目的详细设计文档怎么写( 三 )


3.2 构件描述
详细描述结构中的每个软件构件 。
3.2.1 构件过程叙述(PSPEC)
描述构件的过程 。
3.2.2 构件接口描述
详细描述构件的输入和输出 。
3.2.3 构件执行细节
每个构件的详细演算描述 。
3.2.3.1 接口描述
3.2.3.2 演算模型(e.g., PDL)
3.2.3.3 规范/限制
]3.2.3.4 本地数据结构
3.2.3.5 在3.2.3.6设计中包含的执行结果
3.3 软件接口描述
软件对外界的接口描述
3.3.1机器对外接口
与其他机器或者设备的接口描述 。
3.3.2系统对外接口
对其它系统、产品和网络的接口描述 。
3.3.3与人的接口
概述软件与任何人的界面 。
4.0 用户界面设计
描述软件的用户界面设计 。
4.1 描述用户界面
详细描述用户界面,包括屏幕显示图标、图片或者类型 。
4.1.1 屏幕图片
从用户角度描述界面 。
4.1.2 对象和操作
所有屏幕对象和操作的定义 。
4.2 界面设计规范
用户界面的设计和实现的规范和标准 。
4.3 可见构件
实现的GUI可见构件说明 。
4.4 UIDS描述
用户界面开发系统描述 。
5.0约束、限制和系统参数
会影响软件的规格说明、设计和实现的特殊事件 。
6.0测试标准
测试策略和预备测试用例描述 。
6.1 测试的类别
规定实施测试的类别,包括尽量详细的描述 。这里是针对黑盒测试现象的描述 。
6.2期待软件反馈
测试期待的结果描述 。
6.3执行界线
特殊执行需要的说明 。
6.4 重要构件确认
决定性构件或者需要特殊注意的构件的测试确认 。
7.0附录
设计说明的补充信息 。
7.1系统可跟踪矩阵
一个定期回归系统规格跟踪软件需求的矩阵 。
7.2 产品战略
如果规格说明书是为一个产品设计的,描述相关的产品战略 。
7.3 使用分析算法
描述所有分析活动所使用到的分析算法 。
7.4 补充信息 (如果有需要特别说明的)
4.怎么写项目开发的文档软件开发中文档的编写是一个不可缺少的环节,常见的如《需求分析》、《概要分析》、《数据库设计》等 。在“软件人”的阵营里向来存在两种观点,注重文档还是关心代码 。
我这里写一个《用户信息模块的概要设计文档》,只列举主要内容了
1.功能描述:用于完成系统用户信息的新增、删除、修改、查询;
2.功能用例:一个主用例用户信息,附加新增、删除、修改、查询4个子用例,操作人员为管理员,图形就不画了,很简单的;
3.业务流程:查询有效范围用户信息——》新增用户信息——》判断当前帐号是否存在——》存在给出提示,反之保存成功提示 。
4.约束限制:超级管理员可操作所有(包含删除,我这里考虑仅是逻辑删除、非物理删除)的用户信息;系统管理员可操作除系统管理员、超级管理员外的全部用户信息;单位管理员可操作本单位用户信息;用户帐号信息系统内全局唯一;
5.系统性能:要求同时支持500个并发操作;页面操作响应时间小于1s;页面大小小于1kb;
当前用户所属员工信息不存在时,可直接进行员工信息的添加,并完成用户信息的同步保存,确保事务的完整性;
6.运行环境:依赖系统整体运行环境为准(存在特殊需要注明);
7.操作实体:用户信息、员工信息、系统日志等 。
8.异常处理:如果系统框架中已经提供相关说明,这里仅需要注明符合系统架构异常处理方式即可 。
9.外部接口:输入—用户ID,输出—用户信息;