首页   注册   登录
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX  ›  程序员

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

  •  2
     
  •   huangdaxian · 2018-07-24 08:46:10 +08:00 · 5931 次点击
    这是一个创建于 478 天前的主题,其中的信息可能已经有所发展或是发生改变。
    第 1 条附言  ·  99 天前
    这是我去年提的问题,去年文档就写得不咋样,今年又到了写交接文档的时间,希望再来讨教一波经验。
    36 回复  |  直到 2019-08-07 15:59:08 +08:00
        1
    zyp0921   2018-07-24 08:48:46 +08:00
    同问
        2
    mistkafka   2018-07-24 08:55:07 +08:00 via iPhone
    嘲讽一下:“一切都在代码里”
        3
    qingmiyang   2018-07-24 08:55:27 +08:00
    同问
        4
    JokerHuang   2018-07-24 08:55:56 +08:00
    “看代码好了”
        5
    linxl   2018-07-24 08:56:46 +08:00
    结合原型看代码, 告辞
        6
    dalibaxiaoliba   2018-07-24 09:05:23 +08:00 via Android   ♥ 1
    “我来的时候也没啥文档啊”
        7
    crayygy   2018-07-24 09:09:26 +08:00 via iPhone
    吐槽一下说一切看代码,我来的时候也什么都没有的,那还要个毛的交接?交接中的东西基本上可以认为是你在这期间所做的事情的最精炼的总结,写成文档才是对自己的负责态度。
        8
    zjsxwc   2018-07-24 09:22:51 +08:00
    交接文档不都是走个过场吗?给人事看的吧。


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




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

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

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

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

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

    项目交接?

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

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

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

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

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

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

    之前写过一篇类似文章,可供参考
        35
    balabalaguguji   155 天前
    有专门写技术文档的工具的,你可以试下 easydoc.xyz
    效果优雅,编写方便
        36
    huangdaxian   99 天前
    @balabalaguguji 不太适合,并不缺工具,只缺思路
    关于   ·   FAQ   ·   API   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   2678 人在线   最高记录 5043   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.3 · 25ms · UTC 12:16 · PVG 20:16 · LAX 04:16 · JFK 07:16
    ♥ Do have faith in what you're doing.