近期工作原因修改了不少接口,每次交接中都会有很多不方便的地方。要么是没有前人的文档参考,自己只能扒代码;要么是自己提供的接口,懒得动手出文档,结果跟partner对接的时候给对方造成困难。所以,昨天看到这个管理工具后,眼前一亮,决定拿来玩玩。有机会的话部署到办公环境,给其他同学顺手玩玩~

主要功能

  • API文档快速生成和管理
  • MARKDOWN格式模板和实时预览,符合程序员的装逼范儿;

    编辑过的文档可以通过历史记录进行恢复,如果是git追溯的话就牛逼了

  • 数据字典展示
  • 数据字典格式的模板

  • 说明文档维护
  • 其实,各种类型的说明文档都可以这么玩

    补充功能

  • 项目归档
  • 可以按照项目建立文档,通过密码管理项目的公开性

  • 成员管理
  • 项目可以增加成员或者转让项目给成员

  • 文档分享
  • 文档的链接可以分享给其他同学公开访问

    感谢开发者的贡献精神,附上git项目地址showdoc