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

关于开发团队的文档

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

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

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

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

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