V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
yushaw
V2EX  ›  问与答

有什么好用的在线帮助文档生成系统嘛

  •  
  •   yushaw · 2015-11-17 19:44:57 +08:00 · 4690 次点击
    这是一个创建于 3054 天前的主题,其中的信息可能已经有所发展或是发生改变。

    主要用于生成在线的产品说明文档 /帮助中心供用户查阅,需要搭在自己的服务器上。

    找了一圈,觉得看起来不错的其实还不少,但是没找到好用的生成和管理器。

    https://docs.readthedocs.org/en/latest/getting_started.html

    https://leancloud.cn/docs/ios_os_x_guide.html

    http://www.apple.com/cn/support/icloud/

    https://pingxx.com/document/api/

    http://themeforest.net/item/knowhow-a-knowledge-base-wordpress-theme/2813111

    假如支持 Markdown 就更好了, Wiki 那套还是感觉有点繁琐。

    10 条回复    2023-03-13 18:29:03 +08:00
    sunyang
        1
    sunyang  
       2015-11-17 22:27:02 +08:00
    tinyhill
        2
    tinyhill  
       2015-11-17 22:27:36 +08:00
    gitbook
    helloboy
        3
    helloboy  
       2015-11-18 03:41:47 +08:00   ❤️ 2
    MkDocs 不解释
    yushaw
        4
    yushaw  
    OP
       2015-11-18 10:39:18 +08:00
    @sunyang 看起来不错,不过好像只能用对方的域名 😒
    yushaw
        5
    yushaw  
    OP
       2015-11-18 10:40:30 +08:00
    @helloboy 啊 谢谢 看起来很不错。
    sunyang
        6
    sunyang  
       2015-11-18 13:38:29 +08:00
    @yushaw 可以绑定自己域名啊
    http://help.kancloud.cn/48104
    yushaw
        7
    yushaw  
    OP
       2015-11-18 15:15:42 +08:00
    @sunyang 噢 刚才没找到,好像建团队之后就看到了。 谢谢 :)
    balabalaguguji
        8
    balabalaguguji  
       2019-06-13 14:03:55 +08:00
    强烈推荐易文档,比较偏向给开发者用的文档平台,[https://easydoc.xyz]( https://easydoc.xyz)
    saywujian
        9
    saywujian  
       2020-10-26 11:50:14 +08:00
    你这上面的很多都打不开了,制作在线帮助文档,国内推荐:Baklib ( baklib.com ) 国外推荐:zendesk ( zendesk.com )和 gitbook(gitbook.com)
    Baklib
        10
    Baklib  
       2023-03-13 18:29:03 +08:00
    企业如何快速制作帮助文档,有什么便捷工具吗?支持 Markdown

    在编写帮助文档之前,需要先确定受众群体,例如初学者、高级用户或管理员等,以便更好地针对其需求和水平编写文档。确定文档类型:帮助文档可以分为用户手册、快速入门、FAQ 等不同类型。需要根据实际情况选择适合的文档类型。使用简单明了的语言:帮助文档需要使用简单明了的语言,避免过于专业化或使用大量行业术语,以便初学者也能理解。采用结构化的格式:帮助文档需要采用结构化的格式,例如标题、目录、段落、列表等,以便读者能够快速找到需要的信息。

    一、帮助文档的价值
    帮助文档是一种描述产品或服务的文档,通常用于向用户提供使用指南、教程和支持信息,以帮助他们更好地理解和使用产品或服务。帮助文档的价值在于:
    1.提高用户体验:帮助文档可以让用户更快速地上手使用产品或服务,减少用户的疑惑和不便,提高用户的满意度。
    2.降低支持成本:帮助文档可以减少用户对技术支持的依赖,减轻技术支持的工作压力和负担,降低支持成本。
    3.增强品牌价值:帮助文档可以传达产品或服务的价值和特点,增强品牌形象和价值。
    4.提高产品或服务的质量:帮助文档可以帮助产品或服务更好地满足用户的需求和期望,提高产品或服务的质量。
    二、如何制作帮助文档
    制作帮助文档需要遵循一定的原则和步骤,以下是一些制作帮助文档的基本原则和步骤:
    1.目标受众:确定帮助文档的目标受众,包括用户的技术水平、使用场景、需求等,以此为基础编写适合目标受众的内容。
    2.结构清晰:帮助文档应该遵循清晰的结构和层次,以便用户能够快速找到所需信息。通常采用目录、索引、标题等方式进行组织。
    3.简明扼要:帮助文档应该尽可能简明扼要地描述产品或服务功能和使用方法,避免冗长和复杂的表述。
    4.图文并茂:帮助文档可以采用图文并茂的方式进行描述,以便用户更好地理解和使用产品或服务。图像应该清晰、简洁、准确,并配以简短的说明。
    5.实用性:帮助文档应该具有实用性,即能够解决用户实际遇到的问题,提供有用的信息和指导。
    6.易于维护:帮助文档应该易于维护和更新,以保证其与产品或服务的实际情况相符。
    三、制作帮助文档工具推荐 Baklib
    Baklib 是一款非常优秀的知识管理工具,它不仅可以帮助用户管理和分享知识,还可以用于制作帮助文档。以下是 Baklib 制作帮助文档的几个特点:
    1.多种内容格式:Baklib 支持多种内容格式,包括文本、图片、音视频等,用户可以根据需要选择适合的内容格式进行制作。
    2.团队协作:Baklib 支持多人团队协作,用户可以与团队成员一起制作和管理帮助文档,提高制作效率。
    3.多种模板:Baklib 提供多种模板,用户可以根据需要选择适合的模板进行制作,快速生成符合要求的帮助文档。
    4.版本控制:Baklib 提供版本控制功能,用户可以对帮助文档的不同版本进行管理和比较,方便维护和更新。
    5.知识共享:Baklib 支持知识共享功能,用户可以将制作好的帮助文档分享给团队成员、客户、合作伙伴等,方便知识共享和传播。
    总之,Baklib 是一个非常实用和强大的制作帮助文档工具,可以帮助用户快速、高效地制作和管理帮助文档,提高用户体验和降低支持成本。如果你正在寻找一款优秀的制作帮助文档工具,Baklib 绝对是一个值得推荐的选择。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   981 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 28ms · UTC 20:11 · PVG 04:11 · LAX 13:11 · JFK 16:11
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.