软件开发中文档的编写是一个不可缺少的环节，常见的如《需求分析》、《概要分析》、《数据库设计》等。在“软件人”的阵营里向来存在两种观点，注重文档还是关心代码。

我这里写一个《用户信息模块的概要设计文档》，只列举主要内容了

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

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

业务流程：查询有效范围用户信息——》新增用户信息——》判断当前帐号是否存在——》存在给出提示，反之保存成功提示。

约束限制：超级管理员可操作所有（包含删除，我这里考虑仅是逻辑删除、非物理删除）的用户信息；系统管理员可操作除系统管理员、超级管理员外的全部用户信息；单位管理员可操作本单位用户信息；用户帐号信息系统内全局唯一；

系统性能：要求同时支持500个并发操作；页面操作响应时间小于1s；页面大小小于1kb;当前用户所属员工信息不存在时，可直接进行员工信息的添加，并完成用户信息的同步保存，确保事务的完整性；

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

操作实体：用户信息、员工信息、系统日志等。

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

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

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

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

项目组中也不是所有人都必须参与文档的编写，通常业务需求人员、设计人员、架构师、项目经理、小组长占大多数，而且这些人中很多也不是专注于写代码的角色。

===========================================================================

按照以下格式填就好了，不过是我自己写的，有不好的地方大家互相学习修改一下

详细设计文档规范

1.0概述 这部分提供对整个设计文档的概述。描述了所有数据，结构，接口和软件构件级别的设计。

1.1 目标和对象 描述软件对象的所有目标。

1.2 陈述范围 软件描述。主要输入，过程功能，输出的描述，不考虑详细细节。

1.3 软件内容 软件被置于商业或者产品线中，讨论相关的战略问题。目的是让读者能够对“宏图”有所了解。

1.4 主要系统参数 任何商务软件或者产品线都包含软件规定、设计、实现和测试的说明和规范。

2.0 数据设计 描述所有数据结构包括内部变量，全局变量和临时数据结构。

2.1 内部软件数据结构 描述软件内部的构件之间的数据传输的结构。

2.2 全局数据结构 描述主要部分的数据结构。

2.3 临时数据结构 为临时应用而生成的文件的描述。

2.4 数据库描述 作为应用程序的一部分，描述数据库结构。

3.0 结构化和构件级别设计 描述程序结构。

3.1 程序结构 详细描述应用程序所选定的程序结构。

3.1.1 结构图 图形化描述结构。

3.1.2 选择性 讨论其它可供考虑的结构。选定3.1.1中结构类型的原因。

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 补充信息 （如果有需要特别说明的）

===========================================================================

1、系统流程描述： 1.1.1 项目名称项目名称（项目类型） 1.1.2 项目开发者 成员一：成员二：成员三： 1.1.3 项目开发环境MyEclipse + Tomcat5.5和MyEclipse（自带）+ SQLServer 2005 1.1.4 系统功能设定品红商业网分为2大模块：

1.前台系统

设定新闻，商品以及购物相关功能： NEWS：对新闻的增加、删除和查询操作，并且增加上下条功能进行查询，以及最新新闻的显示与增加。

PRODUCT：对商品的增加、删除、修改和查询操作，并且增加分页技术进行查询，以及最新商品的展示与增加；增设对商品的选购，打印清单、结算功能。

TALKING：用户之间的在线聊天，进行互动交流，洽谈业务，对信息发表自己的看法等，并设有广告介绍，让用户了解最新信息。

MESSAGE：客户留言薄，针对各种商情，业务交流进行离线留言，站外，站内用户可以通过此信息及时了解最新资讯，了解用户反馈信息等。 ABOUT：介绍了公司对客户的信心，诚意做出了诚恳的表态。

AFTER：介绍了公司关于商品的售后服务条例等，给客户提供更满意的服务。 COPYRIGHT：介绍了公司的版权信息，以及法律授权及其相。

2.后台管理系统

设定对管理员，用户以及管理员对新闻和商品信息的相关操作。 ADMIN：对用户的查询和删除，对新闻的增加，删除和查询，对商品的增加、删除、修改和查询，都增设了分页技术更有规范的查询。 并附有时间，让操作人员在任何时候都能得到精准时间，以提高管理员的时间观念。

1.1.5 项目开发技术JSP + JavaScript + HTML

1.1.6 设计思路通过相关技术，一一实现对管理员，站外，站内用户，公司新闻信息，商品信息进行实用的操作。

1.1.7 项目背景本着为客户提供最优质的服务，项目从多角度考虑需求，以求达到客户所需要的功能，实现零距离的操作。

1.1.8 主要模块讲解

1.1.8.1 模块一1. 名称：管理员模块2. 简介：管理员的登录，对相应信息操作 实现了管理员对用户，管理员的操作：1. 对用户的查询，删除（必要的删除），使用分页技术给管理员更好的视觉效果。 添加管理员使用了MD5加密技术，登录及相关操作时的各种精密验证，达到更高的保密性，安全性。

1.1.8.2 模块二1. 名称：新闻模块2. 简介：新闻展示，更新，增加和删除 1.对新闻的查询和删除，使用分页技术给管理员提供更好的操作性能

1.1.8.3 模块三1. 名称：商品模块2. 简介：商品展示，更新，增加和删除 1. 对商品的查询、删除、增加和更新，分别使用分页技术给管理员提供更好的操作

1.1.8.4 模块四1. 名称：用户模块2. 简介：可以进行授权的操作，登录在线聊天进行交流，登录购物台进行选，购。

1.1.8.5 模块五1. 名称：论坛模块2. 简介：可以查看所有的论坛信息，并进行筛选，删除不健康、不文明留言

===========================================================================

项目申请报告，是企业投资建设应报政府核准的项目时，为获得项目核准机关对拟建项目的行政许可，按核准要求报送的项目论证报告。编写项目申请报告时，应根据政府公共管理的要求，对拟建项目从规划布局、资源利用、征地移民、生态环境、经济和社会影响等方面进行综合论证，为有关部门对企业投资项目进行核准提供依据。至于项目的市场前景、经济效益、资金来源、产品技术方案等内容，不必在项目申请报告中进行详细分析和论证。。

===========================================================================

目前没有经典的定义。比较通常的说法是：指对一项特定的软件产品进行测试任务的描述，体现测试方案、方法、技术和策略。内容包括测试目标、测试环境、输入数据、测试步骤、预期结果、测试脚本等，并形成文档。

不同类别的软件，测试用例是不同的。不同于诸如系统、工具、控制、游戏软件，管理软件的用户需求更加不统一，变化更大、更快。笔者主要从事企业管理软件的测试。因此我们的做法是把测试数据和测试脚本从测试用例中划分出来。测试用例更趋于是针对软件产品的功能、业务规则和业务处理所设计的测试方案。对软件的每个特定功能或运行操作路径的测试构成了一个个测试用例。

随着中国软件业的日益壮大和逐步走向成熟，软件测试也在不断发展。从最初的由软件编程人员兼职测试到软件公司组建独立专职测试部门。测试工作也从简单测试演变为包括：编制测试计划、编写测试用例、准备测试数据、编写测试脚本、实施测试、测试评估等多项内容的正规测试。测试方式则由单纯手工测试发展为手工、自动兼之，并有向第三方专业测试公司发展的趋势。

要使最终用户对软件感到满意，最有力的举措就是对最终用户的期望加以明确阐述，以便对这些期望进行核实并确认其有效性。测试用例反映了要核实的需求。然而，核实这些需求可能通过不同的方式并由不同的测试员来实施。例如，执行软件以便验证它的功能和性能，这项操作可能由某个测试员采用自动测试技术来实现；计算机系统的关机步骤可通过手工测试和观察来完成；不过，市场占有率和销售数据（以及产品需求），只能通过评测产品和竞争销售数据来完成。

既然可能无法（或不必负责）核实所有的需求，那么是否能为测试挑选最适合或最关键的需求则关系到项目的成败。选中要核实的需求将是对成本、风险和对该需求进行核实的必要性这三者权衡考虑的结果

===========================================================================