文档

制作在线和离线帮助文档(使用手册),用什么工具比较好?

关注者
104
被浏览
533,006

9 个回答

看到这个问题我一定要回答,近期对文档制作工具进行了整理,在这分享给大家。

Docsify:

Docsify一个神奇的文档站点生成器。它很好地完成了文档生成的任务。重要的是,它可以动态地呈现你的文档,这意味着你无需将 MD 解析为 HTML — 只需要将你的文件放在正确的位置即可!除此以外,Docsify 有大量插件和一些主题可供选择。它也有很好的文档记录(就像文档生成器一样)。当 我自己项目的文档使用这个工具时,我可能会有些偏见。它唯一的问题是(至少对我来说)与 IE 10(正如其在主页上所说)的兼容性不是很好(但是他们正在尝试进行兼容),而且它对相关链接缺少必要的支持


Docute:

Docute v4 文档 Docute 是一个类似于 Docsify 的工具,但它有一个可爱的名字。最新的版本(v4)相比 上一个版本要少一些文档,同时也进行了一定程度的简化。生成的文档看起来简约而优雅。可以使用 CSS 变量 定制主题。

Docute 不像 Docsify 那样拥有强大的插件系统,但它有着自己的优势。它建立在 Vue.js 之上,这导致包的大小相比于 Docsify 要大些,但扩展性好了很多。比如,在你的 MD 文件中,你可以使用一些内置的 Vue 组件,甚至你自己的组件。


Slate:

Slate 文档 Slate 可能是在 GitHub 上记录你的项目以及小星星数量的领头羊(~25,000)。它的文档清晰,语法可读性好,且有 everything-on-one-page 的特点。还具有非常可靠的 GH wiki 文档。它允许 深度主题化 ,但因为文档提供的信息不多,所以你需要自己去源码挖掘。

遗憾的是,它的可扩展性很差,但胜在功能丰富,对于那些需要 REST API 文档的人来说,这似乎是一个不错的选择。请记住,Slate 生成的是静态 HTML 文件,而不是在运行中动态生成文件。


Docusaurus:

Docusaurus 是一个易于维护开源文档生成网站的工具。它是由 Facebook 创建的,使用的是 — 没错,就是它 — React。它可以将 React 组件和库轻松地转换或集成为一个整体来创建自定义页面。无需其他工具,它还可以建立额外的 blog 直接整合到你的文档网站,甚至无需其他工具!它可以与 Algolia DocSearch 很好地集成,使你的文档易于导航。就像 Slate 一样,它会生成静态 HTML 文件。


VuePress:

VuePress 是一个 Vue 驱动的静态站点生成器,由 Vue.js 的创始人开发。这也是生成 Vue.js 官方文档的可靠工具。作为一个生成器,它有非常友好的文档。它还具有一个强大的插件和主题系统,当然也继承了优秀的 Vue.js。uePress 宣称其对 SEO 友好,这是因为它生成并输出的是 HTML 文件。


GitBook:

GitBook 是用于编写 MD 文档和文本的工具。它为你提供了一个在线编辑器和免费 . gitbook.io 域名体验。毫无疑问,在线编辑器很棒,但是涉及到布局,它并没有太多的可定制性。该编辑器还有它的遗留桌面版本。但除非你是在做一个开源的项目,否则你需要为此付费。


我的相关回答:

编辑于 2019-08-15 12:00

小鸟前来报道! Baklib-专业的在线帮助文档、操作指南制作平台。

在互联网时代,大家对很多软件都是无师自通,随便上手就能操作,但是在很多复杂的软件中,又或是一些设备,想要直接上手操作使用还是有一定的难度,所以对售后客服的要求比较高,如果不及时响应,可能会造成新用户无法使用,体验不好,直接放弃产品的情况。

如果帮助中心如果写的好,可以给用户树立良好的形象,还可以减少员工培训成本,大概可以分类两种:一种是网站帮助中心,直接将帮助中心内嵌到网站;还有一种是帮助文档,添加到产品内部。

帮助中心的作用

这里参考一下“客如云”软件的帮助中心,客如云是面向本地生活服务业商家,为其提供软硬件一体的SaaS整体解决方案,是餐饮零售SaaS行业的领军企业。



点进帮助中心可以看到,由多个部分板块组成,从产品介绍、更新、常见问题、使用场景等等,分类明确,内容直观清晰。



帮助中心囊括三方面内容:

  1. 产品介绍:介绍产品的主要功能模板块,产品的计费,购买说明等以及产品中涉及的相关词汇;
  2. 入门和使用:介绍如何使用产品的各种功能,使用场景以及产品的操作指南,包括个性化配置、常用配置和其他配置;
  3. 常见问题:在使用过程中经常遇到的问题以及解决方案。

在制作帮助中心的时候需要考虑用户使用感受以及是否便捷,是否解决了用户当前的问题。

如何编写好帮助中心

帮助中心最重要的是帮助用户快速方便的搜索到信息,以用户的任务为核心,列出相应的步骤,但文字不要太多。在布局排版上需要清晰直观,可以参考一下百度爱番番的帮助中心。





百度爱番番和客如云的帮助中心,样式不同,但是都秉承着以上几点要求,据了解,他们使用的是Baklib制作的, Baklib是一款专业的云端帮助中心、知识库制作平台, 为企业提供多种不同的帮助中心模板。

其中比较重要的一点优势是其简单易用,不需要掌握编程,入门很容易,节省了不少时间,零试错成本,想要做一个帮助中心,选择一个官方主题,自主进行问题填充,完成展示即可,可以直接将链接添加到官网,用户只需要点击链接就能跳转到帮助中心界面,通过搜索找到解决方案。

使用地址:



案例参考:

编辑于 2021-02-04 14:29

今天给大家分享下中小企业制作知识库工具TOP前5!

一、Baklib

Baklib这是一款专业的 知识库制作工具,拥有不俗的在线编辑能力,多端适配在哪都可以轻松创作,内容管理能力方面拥有多级分类、标签管理、团队协同等功能,而且不需要下载下来,只需要访问官网就能够使用,但是编辑十分流畅一点也不卡顿。满足了不同人群知识的创作与存储。不得不吹的是它的知识分享能力,使用Baklib制作的内容可以转化一个个精致的站点(20+主题随意选),在方便内容分享的同时还加入了站点访问权限的功能,保障知识的安全性。



软件优势:

  • 采用块状的编辑器,所有的内容包括文本、图片、视频、表格、Markdown等内容皆为模块。
  • 支持整个站点的数据导出。
  • 易于阅读:Baklib提供了20+可自定义页眉页脚的主题,让收集整理的内容更具阅读性。

二、Notion


Notion 是一款当下非常流行的笔记工具,由于其独特和灵活的使用方式,它很适合作为知识管理软件。和传统的笔记软件不同,Notion采用了模块化的设计,每个段落都是一个独立的区块,可以自由拖拽和布局,而且区块还可以设置为各种类型,包括标题、待办、列表、引用、图片、视频等,甚至还提供了第三方嵌入功能,你可以在其中加入网页片段、代码、思维导图、流程图等模块,创建内容丰富的文档。



三、石墨文档

石墨文档比较突出的就是他的协同功能,不过这个对于企业来说比较适用,支持多人编辑文档或者Excel,十分方便,在写了文档之后可以直接分享给他人一起讨论更改。



四、印象笔记或 OneNote

印象笔记真的是一款非常棒的知识迭代工具,曾一度我在中非常依赖这款工具,但是它的价格还是超出我的预期,所以只能忍受每个月 30M 的空间,光是写文字还好,一旦插入图片或者语音就根本不够使用,由于替代的软件工具比较多,后来我放弃了使用,但是它真的很好用,这里我也推荐使用 OneNote。





五、幕布或 Xmind

一般来说,对于知识结构的梳理我会选择幕布和 Xmind 这两个工具,因为用幕布和 Ximnd 构建知识框架,真的非常清爽,不过我还是强力推荐大家使用幕布,因为幕布也是支持网页版和电脑端,手机端,同步起来很方便。有时候我读完一本书或者分析一个问题的时候,我一定会在一个安静的地方,带上耳机然后喝一杯咖啡,将问题梳理出来,然后认真分析最后做决定,在这个复杂的社会,我们真的有时候需要静下来思考。


发布于 2023-04-17 16:32

手册写作推荐看云,天生为结构化写作而设计,基于MD和GIT版本库,支持在线和离线写作和协作,实时自动保存,并支持各种插件,所以可以轻松应对一些复杂的需求(比如数学公式、流程图、时序图等),阅读的话可以支持网页、手机和小程序,针对手册来说 域名绑定和自定义导航的需求是非常多的,看云这两块做的比较灵活,如果你要制作离线手册,一方面可以下载PDF、EPUB或者word文档,另外也可以下载HTML格式部署到自己的服务器上,足够满足企业的手册需求。

阅读效果(默认主题)

支持MD模式和可视化模式的切换编辑

编辑界面(MD模式)
编辑界面(可视化模式)



发布于 2020-04-12 22:56

最土的,Word ...

Dr.Explain,这个是一个离线的制作工具,自带截图工具,并且可以生成固定格式内容。

在线的, markdown格式的编辑器怎么样?

http://

www.jianshu.com

简书,

http://

www.ewendang.com

易文档,

http://

www.zybuluo.com

作业部落,

http://

www.gitbook.com

gitbook

编辑于 2015-11-13 17:50

Sphinx



或者hexo


或者mkdocs

编辑于 2019-08-18 17:48

BizHelp

目前只找到这个,其他的楼下请补充,其实我也想知道

发布于 2015-03-20 16:34

1. 使用开源系统:可以选择使用开源的帮助中心系统,比如wordpress 、Docusaurus等系统,这样可以快速搭建起来,并且可以根据自己需求进行二次开发。

3. 使用SaaS工具:如果没有技术背景,或者不想花太多时间和精力去搭建或者运维的话,这是我最推荐的一种方法。比如 HelpLook,可以快速搭建自己的帮助中心。它提供了特定的功能和模板,创建和管理大量支持文档和知识库内容会更加简单和高效。界面也够简洁,非技术背景的人也能很通畅地操作。而且HelpLook提供了高级的AI搜索功能,能够进行智能搜索和问答。

发布于 2024-01-25 19:13
制作在线和离线帮助文档(使用手册),用什么工具比较好?
699 播放 · 1 赞同

这视频介绍了两个工具,

  • Zoho Learn,适合做企业内部/外部知识库。
  • Zoho Wordrive,适合做比较简单的、层级结构不那么复杂的帮助文档。

用 HTML 也很好,自定义程度高,不受工具的限制,想做出什么效果写代码就是。唯一的问题是需要点学习成本,dreamweaver啦,css js 啦什么的,得会一点,完了还得有自己的域名,做网站,做备案,发布页面。维护起来稍微麻烦一点,不像视频里那种工具,就比较简单,模块化的,拖拽就行,不用自己写代码。

发布于 2022-09-07 11:02· 30 次播放