登陆

一个非常适合IT团队的在线API文档、技术文档工具——Showdoc

admin 2019-09-27 322人围观 ,发现0个评论

介绍

每逢咱们接纳其他人开发的模块或项目时,咱们总是会张狂地看着那些没有注释的代码。程序员常常期望其他人写技能文档,而不期望自己写技能文档。由于编写一个非常适合IT团队的在线API文档、技术文档工具——Showdoc技能文档需求花费许多时刻来处理格局和布局,所一个非常适合IT团队的在线API文档、技术文档工具——Showdoc以编写该文档的人有必要考虑各种一个非常适合IT团队的在线API文档、技术文档工具——Showdoc非技能细节,例如在新建的Word文档中应放入哪个目录,各种文档由不同的邻座的怪同学人涣散地保存在一个团队中。然后经过IM或电子邮件从其他人那里接纳文件。这种通讯还不错,可是功率不高。ShowDoc是十分合适IT团队在线同享文档的东西。它能够进步团队成员之间的交流功率。



Github坐标

https://github.com/star7th/showdoc

它能做什么?

  • API文档

跟着移动互联网的开展,BaaS(后端即服务)越来越盛行。服务端供给API,APP端或许网页前端便可便利调用数据。用ShowDoc能够十分便利快速地编写出漂亮的API文档。

  • 数据字典

一份好的数据字典能够很便利地向他人阐明你的数据库结构,如各个字段的释义等。

  • 阐明文档

你完全能够运用showdoc来编写一些东西的阐明书,也能够编写一些技能规范阐明文档以供团队查阅

功用

  • 共享与导出

呼应式网页规划,可将项目文档共享到电脑或移动设备检查。一起也能够将项目导出成word文件,以便离线阅览。



  • 权限办理

  1. 揭露项目与私密项目

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

2、项目转让

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

3、项目成员

你能够很便利地为ShowDoc的项目增加、删去项目成员。项目成员能够对项目进行修改,但不行转让或删去项目(只要项目创建者才有权限)一个非常适合IT团队的在线API文档、技术文档工具——Showdoc

4、团队办理

运用showdoc的团队功用你能够更好地进行团队协作



  • 修改功用

1、markdown修改

ShowDoc选用markdown修改器,无论是修改仍是阅览体会都极佳很棒。假如你不了解Markdown,请在查找引擎查找”知道与入门 Markdown”

2、模板刺进

在ShowDoc的修改页面,点击修改器上方的按钮可便利地刺进API接口模板和数据字典模板。刺进模板后,剩余的便是改动数据了,省去了许多修改的力气。

3、前史版别

ShowDoc为页面供给前史版别功用,你能够便利地把页面康复到之前的版别。



运用方法

你能够挑选运用在线版别或许布置到自己的服务器两种方法可供挑选,在线版别长时间支撑保护,或许参阅布置手册布置到自己的服务器:



官方供给了具体的布置装置文档,还包含二次开发的一些阐明

在线版别

  • 首要需求注册账号


  • 文档办理主页


  • API文档示例


  • 数据字典示例


  • 技能文档示例


  • 新建文档页面


  • 在线API测验


总结

文档办理有许多方法,ShowDoc的首要意图便是处理团队之间的这种文档之间的协作,并且办理起来十分便利,便利相互共享和运用!既能够运用在线版别也能够挑选在自己本地布置十分便利!



PS:Javascript和Py一个非常适合IT团队的在线API文档、技术文档工具——Showdocthon的经典书本,有哪位仁兄能够引荐一一个非常适合IT团队的在线API文档、技术文档工具——Showdoc二,在此感谢!

请关注微信公众号
微信二维码
不容错过
Powered By Z-BlogPHP