1.概述

在开发实践中，一般开发过程是过程是：

• 产品或项目负责人，负责分析需求和设计。
• 负责人将需求交给开发人员，开发人员拿到需求后，负责人会将一些业务和需求及大概的设计和开发人员进行沟通。
• 开发人员需要将需求进行分析和设计，然后和负责人，团队成员，测试人员一起对设计进行评审，一起估算开发时间，并制定开发计划。

本文旨在描述一下，开发人员在拿到需求后，需要提交的开发和设计的详细文档，及文档的主要包含的内容。

该文档的作用在于

• 开发人员首先通过深入思考如何实现，并和负责人进行沟通，这样不容易走偏。
• 在产品交互时，也可以作为开发文档的一部分进行交付。

2.文档需要包含内容

2.1 需求描述

在这里对需求和业务场景进行描述，需要解决什么问题。

2.2 实现过程分析

这里主要写一下实现的过程，可以使用序列图或流程图对需求进行分析和分解。

2.3 界面原型

这里可以使用原型工具对界面进行初步的设计，可以和UI进行沟通。

2.4 数据库设计

这里可以使用POWERDESIGN对数据库进行设计。

3. 案例

下面以平台中的一个审计日志为例子大致描述一下这个文档如何写。

3.1 需求描述

在平台中有些情况下，我们需要记录审计日志，比如登录，退出登录，删除数据，保存数据等等这种，方便运维人员对平台用户系统中的用户操作进行分析和跟踪。

3.2 实现逻辑

我们可以使用流程图加文字进行描述

比如我们访问一个控制器方法。这个方法需要记录审计日志，那么我们需要在这个方法上增加注解。
记录日志流程

1. 访问一个控制器方法。
2. 判断是否有日志注解
3. 如果有那么就产生一个审计日志对象
4. 日志发送接口会将审计日志对象发送到队列。
5. 通过消息队列记录日志。

3.3 数据库设计