IT 工作者如何写交接文档

论坛 期权论坛 脚本     
已经匿名di用户   2022-7-2 21:49   1583   0

背景

最近要离职,被交接的同事不满意自己的文档。

沟通下来,同事需要的自己都有说明,但是同事觉得乱或者找不到,以较好的格式分开写会清晰很多。

自己在网上找了一个靠谱的列表。自己补充了必须注意的。

项目交接文档资料

1.最终源程序代码,要有规范详细的注释;

类说明(模块说明,功能说明,注意事项)

关键类(功能说明,过程注释)

2.程序流程图;

跨模块的流程需要标明,例如登陆。建议用序列图。

3.源程序文件目录清单;

工程说明

4.编译发布的正式版本;

git说明

5.编辑环境、配置参数详细说明文档;

6.安装部署文档;

7.用户使用手册;

8.功能需求文档等。

分享到 :
0 人收藏
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

积分:81
帖子:4969
精华:0
期权论坛 期权论坛
发布
内容

下载期权论坛手机APP