文档章节

showdoc分享

十月初五的月亮
 十月初五的月亮
发布于 2017/04/06 00:07
字数 956
阅读 196
收藏 2

帮助教程

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.cc

版权

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

ShowDoc交流群

  • ShowDoc使用交流qq群
    交流群①:564671853(已满)
    交流群②:174709989
  • 如果你觉得ShowDoc好用,可以转发此文到你的技术社区以支持ShowDoc。感谢支持。

本文转载自:https://www.showdoc.cc/help?page_id=14

上一篇: 给用户添加sudoer
下一篇: git的使用笔记
十月初五的月亮

十月初五的月亮

粉丝 0
博文 71
码字总数 31441
作品 0
朝阳
私信 提问
docker+showdoc搭建

1 安装docker软件 设置环境变量 path 2 从国内安装showdoc镜像 1)docker pull registry.docker-cn.com/star7th/showdoc 备用国外镜像服务器 docker pull star7th/showdoc 2) 创建目录 权限设...

mircle
2018/09/17
8
0
ShowDoc 更新:新增一键自动安装/升级脚本

前言 自动脚本脚本利用docker来安装运行环境,适用于linux服务器。如果你的服务器没有docker服务,脚本会尝试安装之。如果你已经安装过docker,脚本会省略部分步骤,从而加快showdoc安装进度...

xingchen
2018/09/01
1K
1
开发文档开源管理系统ShowDoc

ShowDoc是一款开发文档开源管理系统,国人开发,遵循Apache2 开源协议。 功能: API文档 随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调...

marsdream
2018/07/25
0
0
ShowDoc v2.0 发布,IT 团队的在线 API 文档工具

ShowDoc v2.0 发布了。ShowDoc 是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率。 更新内容: 使用vue + element框架重构了ShowDoc的前端页面,优化UI风格 提高不同页...

xingchen
2018/02/26
6.5K
5
ShowDoc 发布 v2.4.1,支持 LDAP 认证登录

【showdoc v2.4.1 更新公告】 开源版showdoc增加了企业ldap登录的支持,可在管理后台配置。 开源版showdoc增加了是否允许公开注册的开关,可在管理后台配置。 对于showdoc原用户,如果要启用...

xingchen
2018/11/20
1K
2

没有更多内容

加载失败,请刷新页面

加载更多

对比ubuntu与centos系统 ​​​​

CentOS与Ubuntu该如何选择,哪个更好用。笔者在自媒体平台收集了一些网友的观点,较为经典,分享给大家。至于应该选择哪个,希望看完本文章后,读者心中有数。 观点1:CentOS适用于服务器,U...

老孟的Linux私房菜
今天
13
0
Java的基本类型

一、Java的基本类型 Java的基本类型有哪些? boolean char byte short int long float double ? 延伸思考 思考一:为什么有的书籍说Java存在第9种数据类型? 实际上,JAVA中还存在另外一种基...

yumoop
今天
14
0
OSChina 周四乱弹 —— 富婆小时候

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @猿敲月下码 :#今日歌曲推荐# 分享陈慧娴的单曲《夜机》 《夜机》- 陈慧娴 手机党少年们想听歌,请使劲儿戳(这里) @開源中國張學友 :早上...

小小编辑
今天
24
0
MyMinimad ── Linux下用libmad写的mp3解码播放程序(四)

优化了内存使用,不再使用mmap映射整个文件到内存 /* * 本程序是从 minimad 改进而来,如要更详细的说明请参看 minimad.c * * Gu Zhou, 2009/12/25, SiChuan University, China *...

代码强国
今天
18
0
Minikube安装

1、下载Minikube二进制文件 sudo curl -Lo minikube https://kubernetes.oss-cn-hangzhou.aliyuncs.com/minikube/releases/latest/minikube-linux-amd64 2、设置权限 sudo chmod +x minikube......

RogueQ
今天
11
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部