• 首页
        • 更多产品

          客户为中心的产品管理工具

          专业的软件研发项目管理工具

          简单易用的团队知识库管理

          可量化的研发效能度量工具

          测试用例维护与计划执行

          以团队为中心的协作沟通

          研发工作流自动化工具

          账号认证与安全管理工具

          Why PingCode
          为什么选择 PingCode ?

          6000+企业信赖之选,为研发团队降本增效

        • 行业解决方案
          先进制造(即将上线)
        • 解决方案1
        • 解决方案2
  • Jira替代方案
目录

软件帮助文档怎么做

对于一个软件产品系统来说,软件帮助文档要让用户知道你的产品能做什么,怎么使用,以及遇到问题应该怎么解决,主要围绕这三方面来填写内容。其中,产品的简介,一段话简要概括产品的研发目的,使用场景等信息。

一、软件帮助文档怎么做

对于一个软件产品系统来说,软件帮助文档要让用户知道你的产品能做什么,怎么使用,以及遇到问题应该怎么解决,主要围绕这三方面来填写内容。其中,产品的简介,一段话简要概括产品的研发目的,使用场景等信息。

1.产品说明

产品的简介,一段话简要概括产品的研发目的,使用场景等信息。可以直接放在帮助文档的首页,让用户一进来就能直观的看到。

2.操作指南

用步骤一、二、三的方式展示出怎么快速上手使用产品,内容简洁步骤清晰,不需要添加太多描述性的话语。

3.产品功能介绍

对于产品的特点功能进行介绍,包括这个功能的作用,能够用在什么地方,使用方法,进行简单罗列,较好每个功能单独放出来介绍,适当在帮助文档中添加链接的方式引导到别的文章。

4.常见问题

这是帮助文档很重要到一部分,每个问题单独列出来,文字通俗易懂,流程清晰,文字要少,操作步骤类到尽量用图文结合或者视频文字结合的方式,减少用户的阅读难度。

5.应用案例

这方面的内容可以放在帮助文档里面,也可以直接放在产品官网单独列出来,帮助用户了解你的产品,并且放上优异案例,增加用户对产品的信任感,促进转化付费。

延伸阅读:

二、WIKI是什么

Wiki是一种在网络上开放且可供多人协同创作的超文本,支持面向社群的协作式写作,Wiki站点可以有多人(甚至任何访问者)维护,每个人都可以发表自己的意见,或者对共同的主题进行扩展与探讨。

其内容具有极高的关联性,初始架构不好的话可能会造成内容结构零散,不好阅读;Wiki 语法标准不一样,不同的wiki系统采用的语法不一致,造成作者编辑困难;并且结构和页面展示形式较难调整。使用wiki的时候需要遵循一定的准则,精心的编写维护。

相关文章