美文网首页
ShowDoc说明与帮助

ShowDoc说明与帮助

作者: 求知笔记 | 来源:发表于2019-01-31 10:58 被阅读146次

本文内容摘自ShowDoc帮助文档。
Show me the doc !

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

随着移动互联网的发展,BaaS(后端即服务)越来越流行。

支持使用在线的ShowDoc

  • 如果你没有自己的服务器,但又想使用ShowDoc作为分档分享工具,你可以使用在线的ShowDochttp://www.showdoc.cc
  • 在线showdoc作为在线服务会长期维护,请放心托管数据

支持部署到自己的服务器

它可以用来做什么

  • API文档( 查看Demo
  • 随着互联网技术的发展和应用软件的成熟SaaS(软件即服务),越来越流行;BaaS(后端即服务)也慢慢应用起来。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。

  • 数据字典( 查看Demo
    • 一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
  • 说明文档 ( 查看Demo
    • 你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅

它都有些什么功能

  • 分享与导出
    • 响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。
  • 权限管理
    • 公开项目与私密项目
      • ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。
    • 项目转让
      • 项目创建者可以自由地把项目转让给网站的其他用户。
    • 项目成员
      • 你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)
    • 团队管理
      • 利用showdoc的团队功能你可以更好地进行团队协作
  • 编辑功能
    • markdown编辑

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

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

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

相关文章

  • ShowDoc说明与帮助

    本文内容摘自ShowDoc帮助文档。Show me the doc ! ShowDoc就是一个非常适合IT团队的在...

  • ShowDoc 安装和API接口测试

    1. 使用自动脚本安装 ShowDoc官网[https://www.showdoc.com.cn/]ShowDoc...

  • showdoc 安装配置

    showdoc官方文档 https://www.showdoc.com.cn/help/[https://www....

  • MAC 安装showdoc

    安装showdoc 下载地址:https://github.com/star7th/showdoc mac 安装:...

  • 帮助说明

    1.点击登录或者注册如果长时间没有跳转登录页面,请检查手机是否可以科学上网或者密钥是否设置正确。 2.点击注册或者...

  • 帮助说明

    帮助说明

  • ShowDoc

    今天分享的是一款超级好用的文档工具——ShowDoc。平时写后台接口,写完给前端工程师用的时候都要提供一份完整的文...

  • linux安装showdoc

    下载ShowDoc安装包 下载地址:https://github.com/star7th/showdoc 进入服务...

  • 文档工具--showdoc(一)

    一、showdoc简介 Showdoc 这款开源(免费)文档管理系统, 可以部署企业内部, 后台使用 php + ...

  • 在线编辑api文档软件收集

    eolinker apizza rap showDoc

网友评论

      本文标题:ShowDoc说明与帮助

      本文链接:https://www.haomeiwen.com/subject/hlcksqtx.html