项目开发文档

1 功能描述：用于完成系统用户信息的新增、删除、修改、查询；

2 功能用例：一个主用例用户信息，附加新增、删除、修改、查询4个子用例，操作人员为管理员，图形就不画了，很简单的；

3 业务流程：查询有效范围用户信息——》新增用户信息——》判断当前帐号是否存在——》存在给出提示，反之保存成功提示。（简单的说下，图形就不画了）

4 约束限制：

超级管理员可操作所有（包含删除，我这里考虑仅是逻辑删除、非物理删除）的用户信息；

系统管理员可操作除系统管理员、超级管理员外的全部用户信息；

单位管理员可操作本单位用户信息；

用户帐号信息系统内全局唯一；

 

5 系统性能：

要求同时支持500个并发操作；

页面操作响应时间小于1s；

页面大小小于1kb；

当前用户所属员工信息不存在时，可直接进行员工信息的添加，并完成用户信息的同步保存，确保事务的完整性；

6 运行环境：依赖系统整体运行环境为准（存在特殊需要注明）；

7 操作实体：用户信息、员工信息、系统日志等（我不知道，大伙在除概要设计时候是否已完成数据库/实体设计了。）；

8 异常处理：如果系统框架中已经提供相关说明，这里仅需要注明符合系统架构异常处理方式即可。

9 外部接口：输入——用户ID，输出——用户信息；

10 其他说明：用户帐号必须定义为字母开头，数字与字母组合，并保证全局唯一；用户密码采用md5算法加密，系统架构已提供相关接口。

11 注意事项：用户帐号不能为空，不能存在空格，不能超过6位；超级用户信息仅在系统初始化中完成其信息写入操作，其他用户无权对其进行修改；

罗列几个文档的要素，这些我觉得是你的模板一定需要定义的：

1 变更版本记录、参考文献、编写人员、审核人员等；

2 制作背景、使用范围、文档作用；

3 文档结构描述、纲要描述、目录描述；

4 辅助编写工具（如viso/rose等建模工具都可以画用例图，但只能选择一种）、文档格式（word、 pdf还是其他）统一。

 

 

转自 http://www.cnblogs.com/roucheng/p/wendang.html