我需要几个文档模板:1、需求规格说明书。2、详细设计文档。3、数据库设计文档。4、技术实施指南。5、部署手册。6、操作手册。
1、需求规格说明书
拿到用户需求后,首先通读一遍。先从整体上把握一下。用户的目标,范围,解决的关键问题。
第一步、先理出一个功能清单。然后将功能分类划分出子功能模块。
第二步、从6方面入手分析。再加上项目的目的、使用范围,构建需求规格说明书。
初始化:基础数据
业务流程:流程、状态控制代码。业务流程图
数据逻辑关系:各个功能模块之间逻辑关系
业务逻辑控制:逻辑控制点,输入限制,按钮权限限制,关键算法,编码规则等。时间维度控制(以时间为主线驱动业务),流程维度控制(各种表单审批流程等) 。金额维度控制(随着时间的增加往往金额也会累加,累计达到一定的额度上限就会驱动其他业务流程)
数据存储:单表存储,主从表存储(1-N),多表关联存储(N-N)
功能说明: 功能描述,功能界面,功能约束,输入,处理过程,输出,数据存储,算法
2、详细设计文档
详细设计文档是建立在需求的规格说明书基础之上的进一步细化,换一种方式描述更贴近技术而已。
细化到什么程度合适呢,我的标准是程序员看到这个文档某一功能,就知道怎么去写代码。一目了然很明确该干什么,怎么用代码实现此功能,
他可以对此业务不懂。但知道怎么实现其中的功能点。格式大同小异。如果项目比较大,可以需求的规格说明书基础之上写一个概要设计说明书。
再细化概要设计说明书,就成了详细设计文档。
3、数据库设计文档
数据库设计文档这个文档实际上是详细设计文档的一个附件。
是对数据存储的详细说明,重点是表之间的关系。表分类:分控制表,业务表(再按功能模块分类),基础表等。
表和字段的命名尽量用英文,尽量要做到观其名知其意。写上详细的字段说明。
4、技术实施指南
这个文档一般是项目中技术主力或技术经理写。主要应包括
1)系统架构分层,例如:基于数据的项目一般分层
UI(界面层):常用控件的用法例如Web界面DropDawnlist,treeView,gridView等常用控件的应用示范代码。
BLL(业务逻辑层):业务逻辑的书写代码规范示例。
DAL(数据访问层):对数据的增删改查,事务处理基本操作。例如:微软企业库,ADO.NET实体框架的应用或OR/Maping工具生成的代码。
Model(数据实体层):数据库表到对象的映射。
Command(跟项目有关的公用组件或第三方组件接口):例如:日志处理等。
2)关键算法。
3)公用组件调用方法示例代码。
4)一般常用代码。
5)核心功能模块设计思路及代码实现思路。
6)技术难点解决思路。
7)关键业务流程的控制。
8)程序管理要求。
9)第三方组件的应用示例。例如:调用Log4Net日志处理代码示例。
5、部署手册
项目做完后写部署手册,严格按照部署手册安装部署程序。不足之处要及时修补。
写清楚,程序怎么部署,数据库怎么部署等。
6、操作手册
操作手册基于规格说明书中功能清单,一个个描述清楚就是一个很好的用户手册。
言简意赅,配合抓图界面就能够把功能操作说的很清楚。一般主要内容格式:
1)功能清单
2)各个功能说明
A)功能描述。
B)功能入口,功能界面。
C)界面操作说明。
D)注意事项。
其他外围文档还有很多,有些也很重要比如项目计划文档,这些文档其实是为了给领导看的。如果我说的上面六个文档都写的很好,其他的工作开展就很容易。因为,业务搞清楚了文档写好了,开发代码很简单。一般来说任何一个合格的程序员看到文档都能实现。你找一个人把工作分下去,每个人报周报,让程序员自己报工作任务清单。每周检查任务完成情况就行了。
最后告诫:项目经理或主管要充当教练的角色。指导,而不是直接上场当替补。