请教各位写接口文档时用的 wiki 系统是什么? - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
Marser
V2EX    Wikipedia

请教各位写接口文档时用的 wiki 系统是什么?

  •  
  •   Marser 2016-11-08 16:47:09 +08:00 8218 次点击
    这是一个创建于 3260 天前的主题,其中的信息可能已经有所发展或是发生改变。

    请教各位写接口文档时,用的 wiki 系统是什么?公司自己开发的?还是使用的开源系统? 有没有开源的 wiki 系统推荐?最好是 php 开发的, node 的也接受~

    12 条回复    2016-11-09 10:53:10 +08:00
    66beta
        1
    66beta  
       2016-11-08 16:53:10 +08:00
    什么? PHP ?

    Phabricator
    bugsnail
        2
    bugsnail  
       2016-11-08 16:58:47 +08:00
    apidoc

    就是注释写的有点麻烦
    Marser
        3
    Marser  
    OP
       2016-11-08 17:03:04 +08:00
    @66beta 这是代码审查工具吧?
    xfspace
        4
    xfspace  
       2016-11-08 17:08:52 +08:00 via Android
    自己做一个...
    Markdown ,用 Elasticsearch 做搜索。
    Marser
        5
    Marser  
    OP
       2016-11-08 17:28:53 +08:00
    @xfspace 好 6
    Marser
        6
    Marser  
    OP
       2016-11-08 17:29:03 +08:00
    @bugsnail 好的,谢谢
    glasslion
        7
    glasslion  
       2016-11-08 18:52:11 +08:00
    1. 文档不应和代码分离。 放在外部 wiki ,容易忘记维护 。
    2. wiki 语法太复杂。一般说明性的文档用 markdown 就足够了, 用 gitlab, Phabricator 查看起来很方便
    3. REST API 接口 用 swagger , 这已成为事实标准
    morewe
        8
    morewe  
       2016-11-08 18:59:35 +08:00
    自己写了个。
    jininij
        9
    jininij  
       2016-11-08 19:01:29 +08:00 via Android
    dokuwiki 。无数据库,插件丰富,语法简单完整。
    yubang
        10
    yubang  
       2016-11-08 20:43:15 +08:00
    自己造一个轮子,能看就好
    66beta
        11
    66beta  
       2016-11-09 10:19:23 +08:00
    @Marser 有 wiki 功能的,一步到位
    Marser
        12
    Marser  
    OP
       2016-11-09 10:53:10 +08:00
    @66beta 好的,谢谢~~
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     2434 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 24ms UTC 15:33 PVG 23:33 LAX 08:33 JFK 11:33
    Do have faith in what you're doing.
    ubao snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86