⼗三种技术⽂档模板_⼀个⾮常适合IT团队的在线API⽂档、技
术⽂档⼯具——
介绍
每当我们接管其他⼈开发的模块或项⽬时，我们总是会疯狂地看着那些没有注释的代码。程序员经常希望其他⼈写技术⽂档，⽽不希望⾃⼰写技术⽂档。因为编写技术⽂档需要花费⼤量时间来处理格式和布局，所以编写该⽂档的⼈必须考虑各种⾮技术细节，例如在新建的Word ⽂档中应放⼊哪个⽬录，各种⽂档由不同的⼈分散地保存在⼀个团队中。然后通过IM或电⼦邮件从其他⼈那⾥接收⽂件。这种通信还不错，但是效率不⾼。ShowDoc是⾮常适合IT团队在线共享⽂档的⼯具。它可以提⾼团队成员之间的沟通效率。
Github坐标
它能做什么？
API⽂档
随着移动互联⽹的发展，BaaS(后端即服务)越来越流⾏。服务端提供API，APP端或者⽹页前端便可⽅便调⽤数据。⽤ShowDoc可以⾮常⽅便快速地编写出美观的API⽂档。
数据字典
前端页面模板
⼀份好的数据字典可以很⽅便地向别⼈说明你的数据库结构，如各个字段的释义等。
说明⽂档
你完全可以使⽤showdoc来编写⼀些⼯具的说明书，也可以编写⼀些技术规范说明⽂档以供团队查阅
功能
分享与导出
响应式⽹页设计，可将项⽬⽂档分享到电脑或移动设备查看。同时也可以将项⽬导出成word⽂件，以便离线浏览。
权限管理
1. 公开项⽬与私密项⽬
ShowDoc上的项⽬有公开项⽬和私密项⽬两种。公开项⽬可供任何登录与⾮登录的⽤户访问，⽽私密项⽬则需要输⼊密码验证访问。
密码由项⽬创建者设置。
2、项⽬转让
项⽬创建者可以⾃由地把项⽬转让给⽹站的其他⽤户。
3、项⽬成员
你可以很⽅便地为ShowDoc的项⽬添加、删除项⽬成员。项⽬成员可以对项⽬进⾏编辑，但不可转让或删除项⽬(只有项⽬创建者才有权限)
4、团队管理
利⽤showdoc的团队功能你可以更好地进⾏团队协作
编辑功能
1、markdown编辑
ShowDoc采⽤markdown编辑器，⽆论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown，请在搜索引擎搜索”认识与⼊门 Markdown”
2、模板插⼊
在ShowDoc的编辑页⾯，点击编辑器上⽅的按钮可⽅便地插⼊API接⼝模板和数据字典模板。插⼊模板后，剩下的就是改动数据了，省去了很多编辑的⼒⽓。
3、历史版本
ShowDoc为页⾯提供历史版本功能，你可以⽅便地把页⾯恢复到之前的版本。
使⽤⽅式
你可以选择使⽤在线版本或者部署到⾃⼰的服务器两种⽅式可供选择，在线版本长期⽀持维护，或者参考部署⼿册部署到⾃⼰的服务器：
官⽅提供了详细的部署安装⽂档，还包括⼆次开发的⼀些说明
在线版本
⾸先需要注册账号
⽂档管理⾸页
API⽂档⽰例
数据字典⽰例
技术⽂档⽰例
新建⽂档页⾯
在线API测试

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。