V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
crazybinggan
V2EX  ›  问与答

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

  •  
  •   crazybinggan · Oct 13, 2017 · 1283 views
    This topic created in 3132 days ago, the information mentioned may be changed or developed.

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

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

    2 replies    2017-10-13 14:45:30 +08:00
    Felldeadbird
        1
    Felldeadbird  
       Oct 13, 2017
    不要想着对他人友好。你应该尽量让文档 能够通过机器生成。因为很多时候,随着版本迭代,你会发现你的文档跟不上进度。然后你就不想在更新文档了。
    coderluan
        2
    coderluan  
       Oct 13, 2017
    规范化+自动化
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   5721 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 40ms · UTC 07:00 · PVG 15:00 · LAX 00:00 · JFK 03:00
    ♥ Do have faith in what you're doing.