在线API文档、技术文档工具ShowDoc

【个人开源作品】在线API文档、技术文档工具ShowDoc

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

ShowDoc交流群

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

码字很辛苦,转载请注明来自 第七星尘的技术博客《【个人开源作品】在线API文档、技术文档工具ShowDoc》


不用担心英文j2eeapi看不懂了 提供一种方式 跨多个页面请求或对 Web 站点的多次访问标识用户并存储有关该用户的信息 servlet 容器使用此接口创建 HTTP 客户端和 HTTP 服务器之间的会话 会话将保留指定的时间段 跨多个连接或来自用户的页面请求 一个会话通常对应于一个用户 该用户可能多次访问一个站点 服务器能够以多种方式维护会话 比如使用 cookie 或重写 URL 此接口允许 servlet 查看和操作有关某个会话的信息 比如会话标识符 创建时间和最后一次访问时间 将对象绑定到会话 允许跨多个用户连接保留用户信息 当应用程序将对象存储到会话中或从会话中移除对象时 该会话将检查对象是否实现了 HttpSessionBindingListener 如果实现了 则 servlet 将通知该对象它已经被绑定到会话 或者已从会话中取消对它的绑定 通知是在绑定方法完成后发送的 对于无效或过期的会话 通知是在会话已经无效或过期之后发送的 当容器使用分布式容器设置在 VM 之间迁移会话时 所有实现 HttpSessionActivationListener 接口的会话属性都会得到通知 servlet 应该能够处理客户端选择不加入会话的情况 比如故意关闭 cookie 时 在客户端加入会话前 isNew 一直返回 true 如果客户端选择不加入会话 则 getSession 将对每个请求返回一个不同的会话 并且 isNew 将总是返回 true 会话信息的范围仅限于当前 Web 应用程序 ServletContext 因此存储在一个上下文中的信息在另一个上下文中不是直接可见的 ">不用担心英文j2eeapi看不懂了 提供一种方式 跨多个页面请求或对 Web 站点的多次访问标识用户并存储有关该用户的信息 servlet 容器使用此接口创建 HTTP 客户端和 HTTP 服务器之间的会话 会话将保留指定的时间段 跨多个连接 [更多]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值