开源的在线 API 文档、技术文档工具 ShowDoc

本贴最后更新于 2761 天前,其中的信息可能已经事过境迁

ShowDoc 是什么

每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !!

程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版,想着新建的 word 文档放在哪个目录等各种非技术细节。

word 文档零零散散地放在团队不同人那里,需要文档的人基本靠吼,吼一声然后上 qq 或者邮箱接收对方丢过来的文档。这种沟通方式当然可以,只是效率不高。

ShowDoc 就是一个非常适合 IT 团队的在线文档分享工具,它可以加快团队之间沟通的效率。

它可以用来做什么

  • API 文档( 查看 Demo

    随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供 API,APP 端或者网页前端便可方便调用数据。用 ShowDoc 可以非常方便快速地编写出美观的 API 文档。

  • 数据字典( 查看 Demo

    一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。

  • 说明文档(查看 Demo

    你完全可以使用 showdoc 来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。

它都有些什么功能

  • ** 分享与导出 **

    • 响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成 word 文件,以便离线浏览。
  • ** 权限管理 **

    • 公开项目与私密项目

      ShowDoc 上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。

    • 项目转让

      项目创建者可以自由地把项目转让给网站的其他用户。

    • 项目成员

      你可以很方便地为 ShowDoc 的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)

  • ** 编辑功能 **

    • markdown 编辑

      ShowDoc 采用 markdown 编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解 Markdown,请在搜索引擎搜索"认识与入门 Markdown"

    • 模板插入

      在 ShowDoc 的编辑页面,点击编辑器上方的按钮可方便地插入 API 接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。

    • 历史版本

      ShowDoc 为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。

部署到自己的服务器

使用在线的 ShowDoc

  • 如果你没有自己的服务器,但又想使用 ShowDoc 作为分档分享工具,你可以使用在线的 ShowDoc http://www.showdoc.cc

  • http://www.showdoc.cc 作为在线服务会长期维护,请放心托管你的文档数据,不用担心突然关站的问题。如对数据非常敏感的个人或企业,还是把 ShowDoc 部署到自己的服务器比较好。

版权

  • ShowDoc 遵循 Apache2 开源协议发布,并提供免费使用。
    版权所有 Copyright © 2016 by star7th
    博客:http://blog.star7th.com
    邮箱:xing7th#gmail.com(把#改为 @)
    All rights reserved.

ShowDoc 交流群

  • ShowDoc 使用交流 qq 群
    群号:564671853
  • 如果你觉得 ShowDoc 好用,可以转发此文到你的技术社区以支持 ShowDoc。感谢支持。
  • ShowDoc
    5 引用 • 9 回帖
  • API

    应用程序编程接口(Application Programming Interface)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。

    76 引用 • 421 回帖
  • 开源

    Open Source, Open Mind, Open Sight, Open Future!

    393 引用 • 3380 回帖
  • 创造

    你创造的作品可能会帮助到很多人,如果是开源项目的话就更赞了!

    171 引用 • 988 回帖

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
  • 714593351

    试了一下,挺不错的

  • yangyujiao

    没有文档,没有注释。只有代码,让自己看着页面,F12 去找接口的怎么破···

  • junze

    感谢分享 不错的文档管理工具