我的系统文档如何更具互动性?

时间:2009-03-20 16:45:41

标签: documentation

也许如果我的文档更好,我可以花更少的时间来支持开发人员,花更多的时间来开发自己:

我开发了一个由10个其他开发人员和50个最终用户使用的关键平台。开发人员具有混合能力,从领域专家到相对初学者。因为我是知道核心平台如何工作的人之一,其他开发人员的支持请求通常是通过我。

我们的文档是任何成熟项目的常用描述性内容:我们有一个大型wiki,其中包含所有常用操作过程的详细信息以及广泛的API文档。

不幸的是,它不适合“我如何修复”类型的问题:

是否可以制作一些交互式故障诊断文档,使用户通过标准化的故障查找程序。文档会询问用户一系列问题,并根据用户的输入告诉他们该做什么......这将是一个非常简单的专家系统,或者可能是文档状态机。

这个想法是帮助新手更有条理地思考诊断这个复杂系统中的故障。

我的问题:

  • 是否有任何旨在实现此类用户体验的免费工具?我宁愿不亲自动手。必须有某种形式的互动帮助和框架。文档。

  • 以前是否有人实施过此类系统?

3 个答案:

答案 0 :(得分:1)

如果您只想通过回答问题来获得用户从起点移动到一组可能的解决方案的流程图/统计机器,那么您可以将其实现为一组维基页面,其中可能的对一页上的问题的回答是指向其他页面的链接。

此解决方案依赖于能够将问题的答案表示为链接,如果信息更像表单,则无法解决问题。例如,假设有一个问题是“你有什么牌子的显卡?”答案是300种可能的选择之一。在这种情况下,创建链接会很烦人:)

答案 1 :(得分:0)

如果开发人员提出太多问题,那么我建议让他们自己研究问题并提出答案,然后仔细检查,而不是鼓励他们每次都问你。问别人比自己找答案要容易得多,但是如果他们不自己找他们就永远不会去学习。

如果用户提出了很多问题,那么您可能需要一些用户界面改进。尝试在屏幕顶部或底部的应用程序中添加提示。

对于这两个用户组,维基可以提供帮助。

答案 2 :(得分:0)

  • 维基百科的常见问题
  • 如果错误发生得太频繁,请尝试阻止它或输出更有用的错误消息(例如“如果发生这种情况,可能原因是......)