IT 工作者如何写交接文档

背景：

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

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

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

项目交接文档资料

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

类说明（模块说明，功能说明，注意事项）

关键类（功能说明，过程注释）

2.程序流程图；

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

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

工程说明

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

git说明

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

6.安装部署文档；

7.用户使用手册；

8.功能需求文档等。

IT 工作者如何写交接文档相关推荐

离职交接文档_如何写好离职工作交接文档？
交接文档的重要性一个业务员与客户建立起了私下的信赖关系,可是当他因工作调动而离开原岗位,由另一个人接替的时候,原来的关系很可能就会一下子断裂. 百货商店也一样,如果柜台的营业员换人了,有些顾客就不会 ...
【交接文档】如何写好工作交接文档
反驳不需要写文档的言论有很多工程师都持有一个观点:"不用看(写)文档,文档都在代码里",还有一部分人认为,文档容易过时,很难跟上代码的更新节奏,因而没有必要写文档. 接手业务的时 ...
项目交接文档_项目管理反思
我从尾巴到头来反思我在公司期间和郑州扁担科技有限公司的合作. 我和扁担科技的李总最近的一次交谈,是关于交接项目的. 看到项目交接,可不要认为是项目完成交接哦,而是扁担科技因为人员离职的问题,导致没有能 ...
怎样才能写好项目文档？
今天我们来聊一聊,为什么你不爱写项目文档?以及怎样才能写好项目文档? 我以前看过一个投票,盘点程序员不喜欢的事,有两条和文档相关: 不喜欢写文档: 不喜欢项目文档太少. 看起来很矛盾,却很现实.基本上 ...
先写API文档还是先写代码？你需要这款神器Apifox！
代码未动,文档先行其实大家都知道 API 文档先行的重要性,但是在实践过程中往往会遇到很多困难. 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档.大多数开发人员不愿意写 API 文档的原因是 ...
还在发愁写API文档？推荐一款阿里腾讯都在用的API管理神器！
欢迎关注方志朋的博客,回复"666"获面试宝典前言 ❝ 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档.大多数开发人员不愿意写 API 文档的原因:写文档短期收益远低于付 ...
不写技术文档是个什么梗
写文档在工作中很常见了,正规的公司都有文档,除非是很简单的东西. 文档用来给新人或不熟悉的人的看,出需求也要文档.只凭笔在本子上划几下不能让人懂. 凡是稍微复杂的东西一定用文档梳理流程,有的还有流程图 ...
写接口文档及生成mock数据
写接口文档及生成mock数据在web应用开发的过程中,与前端联调时总会有一些接口,需要接口文档,在接口先行的情况下,前端不能拿到实际的接口进行开发,所以就需要mock数据. 今天搜索了下,阿里在这方 ...
java开发文档怎么写_程序员该不该写技术文档，怎么写文档，易懂又能提升自己...
最近公司项目的调用量突然涨了一大波,很多系统都纷纷扛不住了,于是需要对系统进行优化,系统优化的第一步,便是梳理业务! 在这个过程中,经常出现了这样一些情况,发现数据库的某些字段,没有注释,也没有一定的 ...
写好项目文档有多重要？关于我被百大 UP 主选中又放鸽子这档事
论写好项目文档的重要性和方法. 还记得前段时间火遍全网的合成大西瓜游戏么? 其实当我刚刚听说这个游戏的时候,属于村里刚刚通网,当时这个游戏都已经在网上传遍了,而且也有同学扒光了源码,并公开到了 Git ...

IT 工作者如何写交接文档

背景：

项目交接文档资料

IT 工作者如何写交接文档相关推荐

最新文章

热门文章