几款制作帮助文档的工具汇总
几款制作帮助文档的工具汇总
文章目录
- 几款制作帮助文档的工具汇总
- 为什么需要发布产品帮助文档
- 支持在线用 MarkDown格式的编辑器
- 1、[GitBook](https://www.gitbook.com/)
- 2、[Docsify](https://docsify.js.org/)
- 3 、MrDoc
- 4. YDoc
- 5、VuePress
- 6、[Docusaurus](https://docusaurus.io/)
- 8、MkDocs
- 9 Teedoc
- 10、Hexo
- 11、[Docute](https://docute.org/)
- 12、[Docpress](http://docpress.github.io/)
- 13、[Slate](https://slatedocs.github.io/slate)
- 14、[Noting.io](https://noting.io/)
- 15、[Baklib](https://www.baklib.com/)
- 16、[Releasenotes.io](https://www.releasenotes.io/)
- 17、[Ghost](https://ghost.org/)
- 18、[Atlassian Documentation](https://confluence.atlassian.com/alldoc/atlassian-documentation-32243719.html)
- 19、[Read the Docs](https://readthedocs.org/)
- 20、JSDoc
- 21、TypeDoc
- 22、ESDoc
- 23、Documentation.js
- 24、DocumentJS
- 25、Sphinx
- 26、BizHelp(国内,收费 )
版权所有: 本文为米扑博客原创,或修订后发表,最后更新于 2020-02-18 05:12:49
转载注明: 几款制作帮助文档的工具汇总 (米扑博客)
原文链接: https://blog.mimvp.com/article/38752.html
在使用产品的过程中,经常会遇到问题,需要查看帮助文档和使用说明书。
对于线上的产品来说通常都会有帮助文档,帮助文档的作用就是对用户操作过程中遇到的种种问题做详细的解答,同时也是对产品或者技术的一个整体说明。
为什么需要发布产品帮助文档
- 帮助用户更好的解决问题。
- 在回答中引导用户行为。
- 减小客服压力对新客服起到培训的作用。
- 树立好的品牌形象。
- 有助于产品网络营销。
- 有助于优化网站SEO。
为了帮助您确定合适的工具产品创建帮助,下面列出了最好的几款帮助文档制作工具。
支持在线用 MarkDown格式的编辑器
gitbook:https://www.gitbook.com
简书:http://www.jianshu.com
作业部落:https://www.zybuluo.com
CSDN 博客:https://editor.csdn.net/md
Sphinx:http://www.sphinx-doc.org
Hexo:https://hexo.io , https://hexo.io/zh-cn
MkDocs:https://mkdocs.readthedocs.io ,https://markdown-docs-zh.readthedocs.io
BizHelp:http://www.e-bizhelp.com
为了写 米扑代理 的 帮助文档 ,近期对文档制作工具进行了大量的调研和整理,分享给大家。
1、GitBook
源码:https://github.com/GitbookIO/gitbook
价格:https://www.gitbook.com/pricing
GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书,
1)静态站点:GitBook 默认输出该种格式,生成的静态站点可直接托管搭建 Github Pages 服务上;
4)单HTML网页:支持将内容输出为单页的HTML,不过一般用在将电子书格式转换为PDF或eBook的中间过程;
使用 GitBook 制作电子书,必备两个文件:README.md 和 SUMMARY.md
GitBook 是用于编写 MD 文档和文本的工具。它为你提供了一个在线编辑器和免费域名体验。
毫无疑问,在线编辑器很棒,但是涉及到布局,它并没有太多的可定制性。该编辑器还有它的遗留桌面版本。
2、Docsify
源码:https://github.com/docsifyjs/docsify
可以查看 Showcase 来了解使用 docsify 的文档项目。
Docsify 类似的工具(Similar projects)还有:
Project | Description |
---|---|
docute | Effortlessly documentation done right |
docpress | Documentation website generator |
3 、MrDoc
官网:https://mrdoc.pro/
源码:https://gitee.com/zmister/MrDoc
MrDoc
是基于Python
开发的在线文档系统。
MrDoc 适合作为个人和中小型团队的私有云文档、云笔记和知识管理工具,致力于成为优秀的私有化在线文档部署方案。
你可以简单粗暴地将 MrDoc 视为「可私有部署的语雀」和「可在线编辑文档的GitBook」。
4. YDoc
官网:http://ued.qunar.com/ydoc/index.html
源码:https://github.com/YMFE/ydoc
YDoc 是一个优雅的文档站构建工具,能够基于 markdown 轻松生成完整静态站点,让你专注于文档写作。YDoc 拥有灵活而强大的插件 / 主题机制,开发者可以轻松定制属于自己的文档站点。
5、VuePress
官网:https://vuepress.vuejs.org/zh/
中文:https://www.vuepress.cn
源码:https://github.com/vuejs/vuepress
VuePress 是一个 Vue 驱动的静态站点生成器,由 Vue.js 的创始人开发。这也是生成 Vue.js 官方文档的可靠工具。
作为一个生成器,它有非常友好的文档。它还具有一个强大的插件和主题系统,当然也继承了优秀的 Vue.js。
VuePress 宣称其对 SEO 友好,这是因为它生成并输出的是 HTML 文件。
6、Docusaurus
源码:https://github.com/facebook/docusaurus
Docusaurus 可以与 Algolia DocSearch 很好地集成,使你的文档易于导航。就像 Slate 一样,它会生成静态 HTML 文件。
8、MkDocs
官网:https://mkdocs.readthedocs.io
中文:https://markdown-docs-zh.readthedocs.io
源码:https://github.com/mkdocs/mkdocs
MkDocs 是一个用来生成静态网页的工具,通过 YAML 配置文件,可以将使用 Markdown 语言编写的项目文档转换为静态网页,托管到相应的 web 服务器上,以供他人浏览查阅。
9 Teedoc
官网:https://teedoc.github.io/
源码:https://github.com/teedoc/teedoc
其它类似工具对比
docusaurus
:teedoc
的UI
布局几乎和它类似,不过它使用vue
写的,teedoc
是原生js
, 如果你用的是vue
可以考虑用这个gitbook
: 曾经很好用的工具,但是官方不维护了,转向商业了,不建议再使用docsify
: 只需要一个页面,markdown
在浏览器渲染,而不是预先渲染成HTML
, 好处就是轻量,但是SEO
不太友好,可以用它的SSR
功能,nodejs
编写readthedocs(Sphinx)
: 其实是用了用Sphinx
做为生成工具,Python
官网文档就是这个工具生成的, 很多开源项目使用的工具,readthedocs
只是一个公开文档的网站,你不用自己搭建网站,注册登录就可以开始写文档,对RST
格式支持友好mkdoc
: 也是一个python
写的工具,简单易上手,插件也多,如果你的文档是单一语言的文档,可以使用这个工具
10、Hexo
官网:https://hexo.io
中文:https://hexo.io/zh-cn
源码:https://github.com/hexojs/hexo
hexo,轻量、简易、高逼格的博客
写blog虽然经历了N多不同时代的产品,恒久不变的始终是自己无人问津的网站。
虽然没几个人看,还是隔断时间就要折腾一下。
从最开始的wordpress,到tale,到现在的hexo,网站变得越来越简单,越来越轻量级,这里主要说说hexo的使用。
1)hexo 可以理解为是基于node.js制作的一个博客工具,不是我们理解的一个开源的博客系统。其中的差别,有点意思。
2)hexo 正常来说,不需要部署到我们的服务器上,我们的服务器上保存的,其实是基于在hexo通过markdown编写的文章,然后hexo帮我们生成静态的html页面,然后,将生成的html上传到我们的服务器。
简而言之:hexo是个静态页面生成、上传的工具。
安装教程:hexo——轻量、简易、高逼格的博客
11、Docute
源码:https://github.com/egoist/docute
Docute 是一个类似于 Docsify 的工具,但它有一个可爱的名字。
Docute 最新的版本(v4)相比上一个版本要少一些文档,同时也进行了一定程度的简化,生成的文档看起来简约而优雅,可以使用 CSS 变量 定制主题。
Docsify 和 Docute 几乎相同,但具有不同的 UI 和不同的使用方式。
Docute(60kB)比 Docisfy(20kB)大 3 倍,因为我们使用了 Vue,Vue Router 和 Vuex,而 Docsify 使用的是 vanilla JavaScript。
Docute 支持所有常青浏览器(ever-green browsers),即没有对 IE 进行支持!
这些项目在构建时会生成静态的 HTML,这对 SEO 非常有帮助。
如果你在意 SEO,那你可能会喜欢使用 presite 来预渲染你的网站。
12、Docpress
源码:https://github.com/docpress/docpress
示例:https://github.com/docpress/docpress/blob/master/docs/showcase.md
Docpress从你的项目文档中生成网站,即至少是一个 README.md
文件,它还支持 docs/
中的多个 Markdown 页面。
应用Docpress的示例网站:https://github.com/docpress/docpress/blob/master/docs/showcase.md
13、Slate
官网:https://slatedocs.github.io/slate/#introduction
源码:https://github.com/slatedocs/slate
- Linux 或 MacOS - Windows可能有效,但不受支持。
- Ruby,2.3.1或更新版本
- Bundler - 如果已经安装了Ruby,但bundle命令不起作用,只需gem install bundler在终端中运行即可。
遗憾的是,它的可扩展性很差,但胜在功能丰富,对于那些需要 REST API 文档的人来说,这似乎是一个不错的选择。
请记住,Slate 生成的是静态 HTML 文件,而不是在运行中动态生成文件。
14、Noting.io
免费,在线极简主义和高效发布平台。产品的多功能工具,可用于制作发行说明,产品路线图甚至产品博客。
- 清洁,简单,轻便。
- 也可以用于文档,博客等。
- 与技术和非技术用户友好。
- 搜索引擎友好,因此您的受众可以轻松地在Google或Duck上找到您的产品。
- 支持Markdown和自定义域。
- 无需安装。
- 它仍处于测试阶段,因此,仍缺少诸如Google Drive,Dropbox,Slack,GitHub等集成。
15、Baklib
定价: 2019年10月30日之前注册永久享用“企业版”使用权!
价格:https://www.baklib.com/pages/pricing
16、Releasenotes.io
官网:https://www.releasenotes.io
使用http://ReleaseNotes.io可以管理,共享和推广您的最新产品发行说明和产品帮助文档。
- 简单,干净且易于使用的内容编辑,可让您创建,编辑,发布帮助文档。
- 内容编辑器分为不同的部分,因此您可以根据他们的需求轻松添加新内容。
- 与Slack集成,因此您的团队可以直接从Slack更新帮助文档和发行说明。
- SEO友好。
- 编辑经验不好。
17、Ghost
源码:https://github.com/TryGhost/Ghost
Ghost它是开放源代码内容编辑器应用程序,适用于撰写大量文章或公司有编写和出版需求的人。
- 干净,简单的内容编辑器,易于技术人员和非技术人员使用。
- 具有各种功能:SEO支持,主题支持。
- 可以通过许多第三方应用程序集成:Zapier。
- 适用于各种平台:应用程序,Web,移动应用程序。
- SEO友好。
18、Atlassian Documentation
官网:https://support.atlassian.com
使用Atlassian产品和服务可在线制作产品帮助文档和发行说明。
19、Read the Docs
源码:https://github.com/readthedocs/readthedocs.org
20、JSDoc
官网:https://jsdoc.app
中文:http://www.dba.cn/book/jsdoc/
源码:https://github.com/jsdoc/jsdoc
JSDoc 可能是 JS 最明显和最有名的文档生成器。它支持非常多的标签,并且对几乎所有的编辑器和 IDE 自动完成功能友好。它的输出可以使用多种主题进行定制,并且主题的种类非常多。更有意思的是,使用这个和其他生成器,你可以输出 markdown,以便之后与上面所列的任何文档工具一起使用。
JSDoc是一个根据javascript文件中注释信息,生成JavaScript应用程序或库、模块的API文档 的工具。你可以使用他记录如:命名空间,类,方法,方法参数等,类似JavaDoc和PHPDoc。现在很多编辑器或IDE中还可以通过JSDoc直接或使用插件生成智能提示。从而使开发者很容易了解整个类和其中的属性和方法,并且快速知道如何使用,从而提高开发效率,降低维护成本。
学习教程:JSDoc一个JavaScript API文档生成器
21、TypeDoc
官网:http://typedoc.org
源码:https://github.com/TypeStrong/typedoc
TypeDoc 可视为 TypeScript 的 JSDoc。它榜上有名的主要原因是,支持 TS 类型的文档生成器很少(或者说没有)。通过使用该工具,你可以基于 TypeScript 类型系统来生成文档,包括接口和枚举等结构。遗憾的是,它只支持一小部分 JSDoc 标记,没有 JSDoc 这样的大社区。因此,它没有太多的主题,文档匮乏。IMO 有效使用该工具的最佳方法是使用 markdown 主题插件,并使用其中一个文档工具。
学习教程:
typescript文档化工具——Typedoc
TypeScript 文档化工具: typedoc
22、ESDoc
官网:https://esdoc.org
源码:https://github.com/esdoc/esdoc
ESDoc 在功能上与 JSDoc 相似,支持类似于 JSDoc 的注释标签,对文档代码风格测试或覆盖测试提供了可选的支持,有大量的插件集合。
此外,还有一些针对 TypeScript、Flow 和 markdown 输出的概念验证插件。
学习参考:
ESDoc 自动生成接口文档介绍
ESDoc 与 JSDoc 对比
JSDoc 是目前最火的文档生成工具,它存在的时间也比较长,但是功能上还欠缺一些,比如文档覆盖率、自动测试、搜索等,都没有实现。
并且它的使用比较复杂,需要严格使用标签,过多依赖备注来实现。它最大的坑是同名接口无法区分。
功能 | ESDoc | JSDoc |
---|---|---|
ES标准 | ES6 以上 | ES6 |
模块化 | Class、import & export | Class、import & export、CommonJS、AMD、Prototype |
注释类型 | 块级注释 | 块级注释 |
标签 | 少量标签 | 标签完善,需要严格使用 |
文档内容 | 自动语义化,说明详细 | 注释中提炼 |
覆盖率 | 支持 | 无 |
测试 | 支持 | 无 |
手册 | 支持多个文档 | 支持多个文档 |
搜索 | 支持 | 无 |
插件 | 支持 | 支持 |
同名接口 | 重叠显示 | 分开显示 |
23、Documentation.js
官网:http://documentation.js.org
源码:https://github.com/documentationjs/documentation
Documentation.js 是现代文档生成器,它可以输出 HTML、JSON 或 markdown,具有极大的灵活性。
它支持 ES 2017、JSX、Vue 模版和 Flow 类型。他还能进行类型推断以及原生 — JSDoc 标记。
它有基于 underscore 模版的深度主题选项。遗憾的是,(对我来说)它不支持 TypScript。
24、DocumentJS
官网:https://documentjs.com
源码:https://github.com/bitovi/documentjs
DocumentJS 是文档生成的解决方案,它不像上面的竞争对手那么受欢迎。
支持大多数 JSDoc 和 Google 闭包编译器标记,还能够添加自定义的附加功能。
它默认只生成可主题化的 HTML,但具有很强的扩展性。
25、Sphinx
官网:http://sphinxsearch.com
中文:http://www.sphinxsearch.org
文档:http://www.sphinx-doc.org
Sphinx 是一个用来编写项目文档的工具,Python 官方文档便是用该工具生成。该工具主要支持将 reStructuredText 格式的文件转换为 HTML 、PDF、ePub 等文件。
Sphinx在Python社区应用较为广泛,本身用Python编写,而且Python语言本身也使用Sphinx书写文档。简单应用下来,感觉Sphinx还是比较优秀的文档工具了。
对于Python社区,最常使用的当然就是Sphinx,很多第三方库比如requests, Flask, 甚至Python自身的文档都是用sphinx编写的。它结合reConstructedText(.rst文件),很容易模块化,支持多语言,Pycharm默认的参数就是支持. 一键生成web你方不方,一键切换模板你方不方?
# 安装
pip3 install sphinx
# 在当前目录下生成基本的文件和目录结构, 具体内容要通过rst文件的编写格式
sphinx-quickstart
# 可以输出多种结构
make html/pdf
Sphinx:python项目文档自动生成
26、BizHelp(国内,收费 )
官网:http://www.e-bizhelp.com
BizHelp是国内一款基于Web应用,所见即所得的帮助文档在线制作系统,旨在帮助软件企业、政府、高校、科研院所制作:内部文档、产品说明书、学术论著、设计资料、帮助中心、技术培训资料等,可做到随时编辑随时更新发布。
Bizhelp更注重从细节上展现其强大的编辑功能和帮助性质。Bizhelp在Windows应用环境下,其独有的所见即所得编辑风格和多用户协创功能,通过静态内容发布模式,使客户在短的时间内即时了解所用软件相关信息,有效提高使用者的工作效率。同时,Bizhelp支持CHM/Word导入,HTML/PDF等多文本形式的导出,提交之后即可下载到本地,为客户实时提供所需资料样式。
Bizhelp 特点
支持在线编辑,所见即所得;
支持多用户协创,提高团队工作效率;
支持CHM/Word导入,HTML/PDF等多文本形式导出;(注:选择导入的Word文档须有目录,导入后原文档样式保持不变)
支持多种内容敏感设置,便于快速定位帮助内容;
支持内容变量设置,主要针对文档内需要重复编辑的内容进行一次性写入,避免重复工作。(注:设置变量名称时只能为英文,但内容可以是中文)
支持个性皮肤设置,用户可根据自身喜好一键式选用不同皮肤;
支持Flash、avl等多媒体插入;
支持静态内容发布模式,静态发布可生成纯HTML格式,并可脱离WEB服务器独立运行,方便离线浏览文档,同时还支持动态同步。
价格:http://www.e-bizhelp.com/price.html
参考推荐:
Markdown + gitbook 编写帮助文档
Algolia DocSearch 实现帮助文档全站搜索详解
团队多人协作文档的工具汇总
有哪些好用的文档生成工具, 以及为什么好 (知乎)
帮助企业制作帮助文档的6大“黑科技”工具 (知乎)
制作在线和离线帮助文档(使用手册),用什么工具比较好 (知乎)
帮助制作文档工具Document! X 和HelpStudio的使用小技巧 (知乎)
几款制作帮助文档的工具汇总相关推荐
- 盘点 8 款好用的 API 接口文档管理工具
随着互联网的普及和发展,API 接口已经无处不在.它已经在 Web 应用程序.移动应用程序.云计算.物联网.人工智能等领域中得到广泛应用. 例如,在金融行业中,API 接口可以被用于构建支付服务.银行 ...
- 浅谈使用Word和Baklib制作帮助文档区别
几乎每个产品.应用都会设计常见问题界面.FAQ或帮助文档页面,这是一个产品必不可少的一部分,每个企业都会花上不少时间制作产品帮助文档,方便用户查阅产品使用问题.操作指南,快速上手使用产品,另一方面也是 ...
- 分享一款国内版的Gitbook在线文档创作工具
GitBook满足了文档创作者和读者最原始的需求,让创作者专注于创作,让读者专注于阅读. 但对于国内的用户来说GitBook访问速度较慢,想体验更多功能的话得要付美金而且要绑信用卡很不方便. 网上关于 ...
- SaaS产品你知道哪些?盘点几款在线编辑文档工具
关于SaaS产品云端office/在线编辑文档工具/多人在线文档工具你知道哪些? 随着用户办公.学习需求的日益丰富,产品功能演化也在不断加速.目前,传统的office软件已经不能满足人们云处理.多人协 ...
- 基于javaGUI的文档识别工具制作
基于javaGUI的文档识别工具制作 对于某些文本,其中富含了一些标志,需要去排除,以及去获得段落字数,以下是我个人写的一个比较简单的文档识别工具,含导入文件.导出文件以及一个简单的识别功能. 1.功 ...
- java 接口文档工具_一款Java基于注释的接口文档生成工具
一. 痛点 你还在手动维护接口文档嘛,花一个下午不停的复制粘贴代码里面的注释 接口字段变动,还得去更新文档,更新不及时导致文档不同步 或者你使用了swagger之类的基于注解,依靠运行时的文档工具,看 ...
- spring-boot 一款无侵入型,轻量级的接口文档生成工具apiggs
spring-boot 一款无侵入型,轻量级的接口文档生成工具apiggs 名字叫:apiggs 使用只需两步,先把插件代码引入pom文件,然后编译打包即可 之后项目的target目录下,就会多出一个 ...
- android 文档生成工具,word文档制作生成
在手机上上办公同样简单方便,<word文档制作生成>APP让用户可以使用手机在线编辑文档,摆脱了电脑的束缚,随时随地都能办公.这款软件操作非常简单易上手,遇到不会的操作还有专门的视频讲解, ...
- 一款常用文档生成工具:Doxygen
关注+星标公众号,不错过精彩内容 来源 | 简书 编排 | strongerHuang 程序员的很多文档,特别是有代码的文档,绝大部分都是由一款文档生成工具[Doxygen]生成. 什么是Doxyge ...
- apiDoc 一款很不错api文档生成工具
apiDoc 一款很不错api文档生成工具,在开发接口的时候,需要给同事看相应的接口文档.给大家推荐一个生成文档的工具--apiDoc,最后生成的文档以网页的形式发布,方便快捷,便于阅读. 创建项目目 ...
最新文章
- html显示数据库图片django,django将图片上传数据库后在前端显式的方法
- enumeration学习
- html轮播图鼠标可以暂停,为什么better scroll轮播鼠标点击就会暂停?
- java版本号管理_微服务项目中如何管理依赖版本号?
- python调用ctypes中windll中的方法超时处理_python中使用ctypes调用MinGW生成的动态链接库(dll)...
- vs 选定内容没有属性页_从智能单品,到全屋智能:2019中国智能家居发展白皮书【附82页PPT】...
- html布局基础,HTML 布局 - HTML 基础教程
- camera ---(6)双摄成像原理
- javascript 原生事件综合查询
- C语言时间片轮转调度算法
- 计算方法(数值分析)实验:勒让德多项式求展开的三次平方逼近多项式代码实现 java
- 2022江苏省安全员A证考题及答案
- Lample-Ziv文本压缩(java实现)--学习笔记
- 还在为美容护肤问题焦虑吗?不妨试试红光光浴#大健康#红光光浴#红光#种光光学
- python 妹子图抓取
- jflash烧录教程_Jlink flash 烧录HEX 程序
- 程序员女友在京东被领导“潜规则”,竟然不回绝:表明非单身会影响绩效
- OCTAFX滑点滑到令人发指 现在出金也不给出金是黑平台无疑了
- 为了广大AI男的婚姻幸福,求求AI男们不要学习金融男好榜样了
- 【Nginx】配置中 resolver 指令的使用