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

2018-07-24 08:46:10 +08:00
 huangdaxian
12310 次点击
所在节点    程序员
36 条回复
wobushizhangsan
2018-07-24 10:57:54 +08:00
我来的时候接手项目啥文档都没有,我走的时候还得写文档
fin123
2018-07-24 11:03:05 +08:00
罗列接手过的项目,提供以下信息
- 项目 git 地址
- 发布系统对应地址
- 产品、接口、设计文档地址
- 前端、后端、产品、测试相关人员信息
sampeng
2018-07-24 11:21:07 +08:00
“看代码好了”
YMB
2018-07-24 12:16:29 +08:00
有人跟我说 吃泡面不健康 我就笑了
我 TM 都混到吃泡面了 还管它健不健康
ferock
2018-07-24 12:27:21 +08:00
@sampeng +1
@YMB +1

其实我也想优雅的写接口文档,可惜,我司这块并不计入考核 kpi。
jrient
2018-07-24 12:45:10 +08:00
这样
你就把你代码是你马上要出嫁的女儿,
你的女婿是头猪,
然后你就交代吧,每个细节都交代清楚了,你才能放心的让她嫁过去。
Yuansir
2018-07-24 12:57:04 +08:00
都在公司 gitlab 上
Light3
2018-07-24 13:25:25 +08:00
代码都有注释
没啥要交接的啊
Biexl
2018-07-24 15:10:44 +08:00
欢迎入坑
cuzfinal
2018-07-24 15:21:35 +08:00
talk is cheap, look at the code
告辞
ofooo
2018-07-24 15:47:57 +08:00
@nicolas0caser 内部知识共享平台用的什么框架? 我也想弄个自己的~~~
nicolas0caser
2018-07-24 21:20:08 +08:00
@ofooo PHP 团队的小伙伴们基于 dokuwiki 二次开发
mingyun
2018-07-24 22:42:48 +08:00
@nicolas0caser dokuwiki 这个我们团队在用
cnfeat
2019-03-04 22:58:13 +08:00
如何写好离职工作交接文档? - 知乎
https://zhuanlan.zhihu.com/p/27434051

之前写过一篇类似文章,可供参考
balabalaguguji
2019-06-12 11:54:17 +08:00
有专门写技术文档的工具的,你可以试下 easydoc.xyz
效果优雅,编写方便
huangdaxian
2019-08-07 15:59:08 +08:00
@balabalaguguji 不太适合,并不缺工具,只缺思路

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

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

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

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

© 2021 V2EX