• 请不要在回答技术问题时复制粘贴 AI 生成的内容
Livid
403.84D
564.32D
V2EX  ›  程序员

关于开发团队的文档

  •  
  •   Livid ·
    PRO
    · Dec 9, 2014 · 8141 views
    This topic created in 4350 days ago, the information mentioned may be changed or developed.
    出于安全及 offline 也可用的目的,最近实践中的一个做法是,用 Jekyll 来作为内部文档的工具,研发团队通过 git 协作,文档就是一个跑在自己机器上的网站。如果有必要,甚至可以把文档网站做成 launchd 任务开机自启动。

    http://jekyllrb.com/
    20 replies  •  2014-12-10 22:50:50 +08:00
    tinyhill
    tinyhill
    Dec 9, 2014❤️3
    1
    gitbook
    dx3759
    dx3759
    Dec 9, 2014
    2
    开发团队文档应该加上全文索引。
    另外一个更大的问题是项目更新了但是文档滞后,靠开发人员自觉是一件成本很高的事情。
    harmy
    harmy
    Dec 9, 2014 via iPhone
    3
    提一下owncloud
    xing393939
    xing393939
    Dec 9, 2014
    4
    dukuwiki不错,有php环境就行
    zhouzm
    zhouzm
    Dec 9, 2014
    5
    自架 readthedoc
    Livid
    Livid
    MOD
    OP
    PRO
    Dec 9, 2014
    6
    @tinyhill 试了一下 Gitbook Editor,感觉不错。就是中文的字间距比较奇怪。
    andy
    andy
    Dec 9, 2014
    7
    文档、文件管理的话,推荐dukuwiki配合插件nspages、pagehere。
    lepture
    lepture
    Dec 9, 2014
    8
    为什么不用 sphinx 呢? Markdown 写个博客是够用的,但是做文档还远远不行呢。
    huigeer
    huigeer
    Dec 9, 2014
    9
    JIRA
    curiousjude
    curiousjude
    Dec 9, 2014
    11
    我们是在内网搭了一个 daux.io 用于客户端的API文档,感觉勉强可用吧。没有搜索功能是个很大的问题,目录的组织也不尽如人意。
    flyaway
    flyaway
    Dec 9, 2014
    12
    ivenvd
    ivenvd
    Dec 9, 2014
    13
    @lepture Sphinx 用于对外文档比较好吧……对内的话,往往不需要那么好的排版,而且团队学习成本太大了……
    virusdefender
    virusdefender
    Dec 9, 2014
    14
    @curiousjude
    @ivenvd

    我们写api文档的东西是我用了两天自己写的。。都没这个高级~
    zyAndroid
    zyAndroid
    Dec 9, 2014
    15
    我们是用 Sphinx 做的
    ryanking8215
    ryanking8215
    Dec 10, 2014
    16
    bitbucket repo的wiki,支持markdown,主要是api描述,markdown完全胜任
    kimmykuang
    kimmykuang
    Dec 10, 2014
    17
    我们是用redmine的,搭建在远程测试服务器上
    TankyWoo
    TankyWoo
    Dec 10, 2014
    18
    我们现在就是这么做的.

    jekyll的模板和Jinja2语法基本类似,修改非常方便。内部有需求可以自主修改.

    inotify 监控文档源文件目录,自动更新.

    除非文档数量庞大、关联性较大,否则用这个还是很轻便的,顶多维护一个Index将文档串联起来。
    yafeilee
    yafeilee
    PRO
    Dec 10, 2014
    20
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   1656 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 63ms · UTC 04:58 · PVG 12:58 · LAX 20:58 · JFK 23:58
    ♥ Do have faith in what you're doing.