关于项目文档,想请大家给我点建议
今天,项目需要写一个模块的外设文档,要求是模块的各个功能是如何处理的,具体到数据库中用到的字段,概因本人刚大学毕业参加工作才2个月,不会写这个东西。
感觉很迷茫,想请大家给我点秘籍,考虑到这个外设文档需要让后来的维护人员通过这个外设文档直接看着这个模块的处理方式。
就这样,我不知道怎么去写,也一点一点的写,花费了5个小时,写的自我感觉太随心所欲了。
我是这样设计的:
1、在excel中给出一个流程图的一览页面,在一览页面中标注出每个功能;
2、在另外一个sheet中, 序号(一览页面中的标注) 功能描述 业务处理 设计的表、视图、存储过程、函数
主要的是业务处理这个我不知道如何用文字描述,描述的可以让维护人员看懂这个功能的处理方式
想请大家帮帮忙,谢谢!