当前位置: 首页 > 科技观察

Githubstar5300+,致力于为程序员开发文档开源管理系统,我是粉丝

时间:2023-03-17 21:37:57 科技观察

每当接手别人开发的模块或项目时,看代码不加注释是不是很疯狂?每次写文档时,我都会花很多时间处理格式和布局等非技术性问题。是车祸吗?有时一个文件是由多个人写的,几种不同的风格混合在一起。读起来难吗?今天给大家分享一个开源的程序员开发文档管理系统——ShowDoc。目前在Github上已经标记为StarSuper5300,1.3KForks(Github地址:https://github.com/star7th/showdoc)可以用来做什么?API文档(查看演示)随着移动互联网的发展,BaaS(BackendasaService)越来越流行。服务端提供API,APP或Web前端可以方便的调用数据。使用ShowDoc,您可以非常方便快捷地编写精美的API文档。数据字典(见Demo)一个好的数据字典可以方便的向别人解释你的数据库结构,比如每个字段的定义。Documentation(ViewDemo)可以用showdoc写一些工具的使用说明,也可以写一些技术规范文档供团队审阅。它有什么功能?分享导出响应式网页设计,项目文档可以分享到电脑或移动设备上查看。同时,项目还可以导出为word文件,供离线浏览。权限管理公共和私人项目:ShowDoc上有两种类型的项目:公共项目和私人项目。公共项目可以被任何登录和未登录的用户访问,而私有项目需要输入密码来验证访问。密码由项目创建者设置。项目转让:项目创建者可以自由地将项目转让给网站的其他用户。项目成员:您可以轻松地为ShowDoc项目添加和删除项目成员。项目成员可以对项目进行编辑,但不能转移或删除项目(只有项目创建者才有权限)团队管理:可以使用showdoc的团队功能,更好的进行团队协作编辑功能markdown编辑:ShowDoc使用markdown编辑器,两者都有编辑和阅读体验极佳。如果您不会Markdown,请在搜索引擎中搜索“Markdown知识与入门”模板插入:在ShowDoc的编辑页面,点击编辑器上方的按钮,即可轻松插入API接口模板和数据字典模板。插入模板后,剩下的就是更改数据,省去了很多编辑工作。历史版本:ShowDoc为页面提供历史版本功能,您可以轻松将页面恢复到之前的版本。如果不想安装,也可以在线使用ShowDoc。在线地址:https://www.showdoc.cc/创建项目也很简单,只需要跟着步骤一步步创建就可以了:如果你也对这个项目感兴趣,可以下载试试出来。