V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
crazybinggan
V2EX  ›  问与答

想把手头上的项目文档化,尽可能的对他人友好,有什么需要注意或者能给参考下的呢?

  •  
  •   crazybinggan · 2017-10-13 13:49:30 +08:00 · 997 次点击
    这是一个创建于 2600 天前的主题,其中的信息可能已经有所发展或是发生改变。

    自己动手写了下(参考网上的文档),然后给其他人过审,虽然都觉得还行,但是自己总觉的缺些什么就是没头绪。

    所以冒昧上来请教下,一般内部的项目文档化该哪方面着手?

    2 条回复    2017-10-13 14:45:30 +08:00
    Felldeadbird
        1
    Felldeadbird  
       2017-10-13 14:40:39 +08:00
    不要想着对他人友好。你应该尽量让文档 能够通过机器生成。因为很多时候,随着版本迭代,你会发现你的文档跟不上进度。然后你就不想在更新文档了。
    coderluan
        2
    coderluan  
       2017-10-13 14:45:30 +08:00
    规范化+自动化
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3574 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 32ms · UTC 10:55 · PVG 18:55 · LAX 02:55 · JFK 05:55
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.