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

关于开发团队的文档

  •  
  •   Livid · 2014-12-09 13:09:17 +08:00 · 6968 次点击
    这是一个创建于 3645 天前的主题,其中的信息可能已经有所发展或是发生改变。
    出于安全及 offline 也可用的目的,最近实践中的一个做法是,用 Jekyll 来作为内部文档的工具,研发团队通过 git 协作,文档就是一个跑在自己机器上的网站。如果有必要,甚至可以把文档网站做成 launchd 任务开机自启动。

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

    我们写api文档的东西是我用了两天自己写的。。都没这个高级~
    zyAndroid
        15
    zyAndroid  
       2014-12-09 23:14:03 +08:00
    我们是用 Sphinx 做的
    ryanking8215
        16
    ryanking8215  
       2014-12-10 10:04:48 +08:00
    bitbucket repo的wiki,支持markdown,主要是api描述,markdown完全胜任
    kimmykuang
        17
    kimmykuang  
       2014-12-10 11:45:46 +08:00
    我们是用redmine的,搭建在远程测试服务器上
    TankyWoo
        18
    TankyWoo  
       2014-12-10 11:47:38 +08:00
    我们现在就是这么做的.

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

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

    除非文档数量庞大、关联性较大,否则用这个还是很轻便的,顶多维护一个Index将文档串联起来。
    xuhai951753
        19
    xuhai951753  
       2014-12-10 16:21:15 +08:00
    yafeilee
        20
    yafeilee  
       2014-12-10 22:50:50 +08:00
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2636 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 23ms · UTC 07:22 · PVG 15:22 · LAX 23:22 · JFK 02:22
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.