文档章节

showdoc分享

十月初五的月亮
 十月初五的月亮
发布于 2017/04/06 00:07
字数 956
阅读 187
收藏 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
朝阳
私信 提问
开发文档开源管理系统ShowDoc

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

marsdream
07/25
0
0
ShowDoc 更新:新增一键自动安装/升级脚本

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

xingchen
09/01
0
0
ShowDoc v2.2.0 发布,IT 团队的在线 API 文档工具

ShowDoc v2.2.0 发布,IT 团队的在线 API 文档工具。 更新内容: 开源版 showdoc 新增管理后功能,可以从管理后台新增、删除用户,以及对全部项目进行集中管理等。 默认管理员账户密码是 sh...

xingchen
07/25
0
0
ShowDoc v2.3.0 发布,可通过程序自动生成API文档

ShowDoc v2.3.0 发布了,更新内容: 1、可以通过代码注释自动生成API文档,详情看文档https://www.showdoc.cc/page/741656402509783 2、优化json格式化功能 3、fix管理后台的控制台报错 4、登...

xingchen
08/19
0
0
基于 Markdown 的文档发布管理软件 - godoc

showdoc是一个基于 Markdown 的文档发布管理软件,godoc 作为 showdoc 的 go语言重构版本,对原项目做了功能上的精简。 Api文档 数据字典 安装方法

李虎头
05/19
0
0

没有更多内容

加载失败,请刷新页面

加载更多

小白创建一个spring boot项目

进入 https://start.spring.io/

lilugirl
32分钟前
0
0
Alibaba Java诊断利器Arthas实践--使用redefine排查应用奇怪的日志来源

背景 随着应用越来越复杂,依赖越来越多,日志系统越来越混乱,有时会出现一些奇怪的日志,比如: [] [] [] No credential found 那么怎样排查这些奇怪的日志从哪里打印出来的呢?因为搞不清...

hengyunabc
今天
1
0
home hosts

home hosts lwk@qwfys:~$ cat /etc/hosts127.0.0.1 localhost127.0.1.1 qwfys192.168.56.101vm600.qwfys.com39.108.212.91alpha1.ppy.com39.108.117.122alpha2.p......

qwfys
今天
1
0
大数据教程(6.1)hadoop生态圈介绍及就业前景

1. HADOOP背景介绍 1.1、什么是HADOOP 1.HADOOP是apache旗下的一套开源软件平台 2.HADOOP提供的功能:利用服务器集群,根据用户的自定义业务逻辑,对海量数据进行分布式处理 3.HADOOP的核心组...

em_aaron
今天
4
0
hadoop垃圾回收站

在生产生,hdfs回收站必须是开启的,一般设置为7天。 fs.trash.interval 为垃圾回收站保留时间,如果为0则禁用回收站功能。 fs.trash.checkpoint.interval 回收站检查点时间,一般设置为小于...

hnairdb
昨天
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部