再谈在线文档生成工具(1.15)

对于在线帮助文档的生成,我一直在找一个类似开源的工具来做这个事情,需求实际很简单,就是能够很方便的编辑和生成在线帮助文档,API接口帮助文档,同时需要支持Markdown编辑器。在我1年多前在网上搜索的时候,当时实际没有找到比较合适的工具,今天再做下整理。

ShowDoc-在线文档生成工具

地址: http://blog.star7th.com/2015/11/1816.html

简单来说,ShowDoc是一个非常适合IT团队的在线文档分享工具,当然也适合用于制作业务系统的在线帮助文档,制作API接口文档。同时对于ShowDoc来说本身又做了些定制,即除了我们日常的在线帮助文档外,还支持制作API接口文档,数据库设计的数据字典类文档的生成。

对于详细的功能和特点介绍可以参考上面网址和Demo,其中比较重要的有两点:

其一:支持MarkDown编辑器,符合前面我谈到的一个关键需求。

其二:对于API接口文档,数据字典类文档支持模板插入,方便对这类文档进行编辑。

ShowDoc遵循Apache2开源协议发布,并提供免费使用。

http://blog.star7th.com/2016/05/2007.html

如果你没有自己的服务器,你可以使用在线的ShowDoc  http://www.showdoc.cc

易文档: https://easydoc.xyz/#/

这个是商用的一个产品,有免费版本但是功能很弱,也是完全支持Markdown语法。

易文档让您轻松编写和维护高质量的文档。 从需求文档、API文档、部署文档到使用手册,多种定制文档编辑器,满足您整个开发周期需求; 支持接口在线测试,一键生成文档、调用示例、mock配置。 极致的编写体验,优雅的排版,让文档成为一种乐趣。

核心能力包括:

a. 快速编写: 常用参数一键引用,支持Json导入,一键生成文档、调用示例、Mock

b. 支持导出: 可导出PDF、HTML、WORD、JSON

c. 自定义模板: 可灵活自定义文档结构,存为模板,定制专属模板

d. 接口测试 :在线接口测试,可把测试结果存为调用示例、一键生成文档

可以看到这个商用版本的能力还是相当强,特别是对API接口文档的支持能力。整体的编辑功能易用性也不错,而且支持在线预览,支持各种导入。即使对于一个企业来说完全私有化部署费用也不贵。是值得推荐的一款在线文档编写和生成工具产品。

MinDoc接口文档在线管理系统  https://www.iminho.me/

MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂,所以改用 Golang 开发。可以方便用户部署和实用,同时增加Markdown和HTML两种编辑器。

该系统基本可以用来储存日常接口文档,数据库字典,手册说明等文档。内置项目管理,用户管理,权限管理等功能,能够满足大部分中小团队的文档管理需求。从网站看主要功能包括:

项目管理, 可以对项目进行编辑更改,成员添加等。

文档管理, 添加和删除文档,文档历史恢复等。

用户管理, 添加和禁用用户,个人资料更改等。

用户权限管理 , 实现用户角色的变更。

项目加密, 可以设置项目公开状态,私有项目需要通过Token访问。

站点配置, 二次开发时可以添加自定义配置项。

附件管理 ,可管理所有项目中上传的文件。

项目导出 ,目前支持导出 PDF、Word、EPUB、MOBI、Markdown 等格式项目。

标签管理 ,可关系已存在的项目标签

导入项目 ,支持导入Markdown压缩包成为一个项目

二级目录部署 ,支持将 MinDoc 部署到二级子目录

具体帮助参考: https://www.iminho.me/wiki/docs/mindoc/mindoc-summary.md

该项目本身开源,整体感觉简洁易用,也比较适合用于做业务系统的在线帮助文档,而且整体界面风格简洁,也方便和业务系统本身进行集成。

APIPost工具:  https://www.apipost.cn/

ApiPost是一个支持团队协作,并可直接生成文档的API调试、管理工具。支持模拟POST、GET、PUT等常见请求,是后台接口开发者或前端、接口测试人员不可多得的工具 。支持接口调试的同时快速生成、一键导出各种格式的api文档。开发、测试人员再也不用头疼接口文档的编写。

该产品同样有免费版本和商用版本,而且不仅仅提供API接口文档的生成能力,额外也提供了API接口的自动化测试和管理能力,方便团队和研发协同。

我来评几句
登录后评论

已发表评论数()

相关站点

热门文章