ShowDoc中文版电脑版(文档编写)是一款文档编辑软件,officeba免费提供ShowDoc中文版电脑版(文档编写)下载,更多ShowDoc中文版电脑版(文档编写)相关版本就在officeba。
ShowDoc选用全新的Markdown在线编辑器打造出的强劲的aip文档撰写pc软件,用于协助客户轻轻松松迅速编写出api文档。ShowDoc特别适合在线文档编辑共享,以提升精英团队中间的沟通交流高效率,客户一般依靠Markdown英语的语法撰写api文档、数据流图文档、技术资料这些文档。
1、共享与导出来
响应式网站网页制作,可将新项目文档分享到电脑上或移动设备查询。与此同时还可以将新项目导出来成word文档,便于离线浏览。
2、编写作用
(1)markdown编写
ShowDoc选用markdown在线编辑器,不论是编写或是阅读文章感受都极好非常好。假如你没掌握Markdown,请在百度搜索引擎检索”了解与新手入门 Markdown”
(2)模版插进
在ShowDoc的编写网页页面,点一下在线编辑器上边的按键可便捷地插进API插口模版和数据流图模版。插进模版后,剩余的便是修改数据信息了,省掉了许多 编写的气力。
(3)历史版本
ShowDoc为网页页面给予历史版本作用,你能便捷地把网页页面修复到以前的版本号。
3、管理权限
(1)公布新项目与私秘新项目
ShowDoc上的新项目有公布新项目和私秘新项目二种。公布新项目可供一切登陆和非登陆的客户浏览,而私秘新项目则必须输入支付密码认证浏览。登陆密码由新项目创始人设定。
(2)新项目出让
新项目创始人能够随意地把新项目出让给网址的别的用户。
(3)新项目组员
你能很便捷地为ShowDoc的新项目加上、删掉新项目组员。新项目组员能够对新项目开展编写,但不能出让或删掉新项目(仅有新项目创始人才有管理权限)
(4)团队协作
你能填加好几个精英团队,为精英团队分派不一样的新项目,与此同时设定精英团队里每一个人的管理权限。
1、API文本文档
伴随着移动互联的发展趋势,BaaS(后面即服务项目)愈来愈时兴。服务器端给予API,APP端或是网页页面前面便可便捷启用数据信息。用ShowDoc能够十分便捷迅速地编写出美观大方的API文本文档,与此同时还将适用从编码文档中自动生成API文本文档
2、数据流图
一份好的数据流图能够很便捷地为他人表明你的数据库查询构造,如每个字段名的释意等。
3、表明文本文档
你彻底能够应用showdoc来撰写一些专用工具的使用说明,还可以撰写一些技术标准表明文本文档以供精英团队查看。
ShowDoc操作方法
安装:
#免费下载脚本制作并授予管理权限
wget https://www.showdoc.cc/script/showdoc;ch mod x showdoc;
#默认设置安装汉化版。假如想安装英语版,请再加上en主要参数,如 。/showdoc en
./showdoc
别的指令:
#实行上边指令便会自动安装进行。下边另附脚本制作别的指令,便于管理方法showdoc时能够用得着。
#终止
./showdoc stop
#重新启动
./showdoc restart
#升级showdoc到最新版本
./showdoc update
#卸载掉showdoc
./showdoc uninstall