如何优雅地撰写交接文档?

2018-07-24 08:46:10 +08:00
 huangdaxian
12180 次点击
所在节点    程序员
36 条回复
zyp0921
2018-07-24 08:48:46 +08:00
同问
justdoit123
2018-07-24 08:55:07 +08:00
嘲讽一下:“一切都在代码里”
qingmiyang
2018-07-24 08:55:27 +08:00
同问
JokerHuang
2018-07-24 08:55:56 +08:00
“看代码好了”
linxl
2018-07-24 08:56:46 +08:00
结合原型看代码, 告辞
dalibaxiaoliba
2018-07-24 09:05:23 +08:00
“我来的时候也没啥文档啊”
crayygy
2018-07-24 09:09:26 +08:00
吐槽一下说一切看代码,我来的时候也什么都没有的,那还要个毛的交接?交接中的东西基本上可以认为是你在这期间所做的事情的最精炼的总结,写成文档才是对自己的负责态度。
zjsxwc
2018-07-24 09:22:51 +08:00
交接文档不都是走个过场吗?给人事看的吧。


电脑主机:1 台
键盘:1 个
鼠标:1 个
显示器:2 个
在职期间创作的代码:已在公司 git 托管,git 账号已移交主管,如以后有什么不懂可联系我 qq:xxxxxx




以上
Hucai
2018-07-24 09:26:33 +08:00
当年离职,领导不仅让把工作内容、进度留下,还要把掌握的知识点留下,整理成文档给新人
jianpanxia
2018-07-24 09:45:23 +08:00
离职可能有三种情况
1. 愤怒离场,从此相逢成路人
2. 离不离职都一样,反正都是工作,就普通应对
3. 离职之后还是好朋友,没事回来喝喝茶,吹吹水

看选择哪种咯~~
mentalkiller
2018-07-24 09:48:30 +08:00
@Hucai #9
这怕不是交接了,这怕是在帮领导培养新人了
huangdaxian
2018-07-24 10:11:46 +08:00
@zjsxwc 这是行政交接的文档,项目也要交接的啊
huangdaxian
2018-07-24 10:12:55 +08:00
@jianpanxia 我想离成第三种,公司食堂还是蛮不错的。可惜领导挽留着挽留着要变成第一种了。
jimliang
2018-07-24 10:14:16 +08:00
『代码即文档』
maichael
2018-07-24 10:20:13 +08:00
主要看你离职的原因还有接你锅的人跟你关系怎么样。

其实如果不是项目太复杂,或者项目转手太多次导致代码太脏,只要简要的写关键点就行了。
huangdaxian
2018-07-24 10:23:11 +08:00
@maichael 代码不脏,但业务涉及多系统,我怕别人无法理解我的设计思维。

因为平常我们开发留下的文档也是很少的。
nicolas0caser
2018-07-24 10:25:02 +08:00
基本上就是:以前做过什么(完成的,未完成的),现在在做什么(进行中),未来要做什么(提交到项目日程中的),这三部分了。类似写了几天高考作文,又重温了一下议论文的三段论。

一直觉得我司没有知识沉淀或者没有统一平台,所以入职后怂恿领导搭了一套内部知识共享平台,所以,很多时候身边小伙伴离职时,写文档也轻松了许多,直接在里面写,用到的链接,直接引用内部链接、以前自己总结过的项目 /知识链接等等,整个世界都清净了。离职的小伙伴开开心心,入职的小伙伴开开心心。
zjsxwc
2018-07-24 10:27:23 +08:00
@huangdaxian #12

项目交接?

前端有什么好交接的,看代码呗,汗。

后端最多写个文档解释下数据库表用途、主要的业务代码拎 2 个出来说明下。

说实话接收文档的人能不能看懂项目是他自己的事情,关交接什么事。

如果闲字数不够就把项目里用到的框架的官方文档扒过来改下标题也一起复制黏贴上去,这是我一个外包朋友的做法。
lizz666
2018-07-24 10:29:24 +08:00
刚写完交接文档
zhaogaz
2018-07-24 10:36:44 +08:00
大概就是把自己做过的东西整理成文档。给下一个需要用的人。。

没 sha 优雅的

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/473522

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX