Question

Closed. This question is seeking recommendations for books, tools, software libraries, and more. It does not meet Stack Overflow guidelines. It is not currently accepting answers.

我们不允许问题寻求建议书籍、工具、软件图书馆等等。您可以编辑的问题,因此它可以回答与事实和引用。

Closed 5 years ago.

如果我更使我的文档我可以花更少的时间支持开发人员和更多的时间发展自己:

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

我们的文档通常是描述性的东西任何成熟的项目有:我们有一个大的wiki包含所有常见的操作程序的细节加上广泛的API文档。

不幸的是它没有照顾好“如何解决”类型的问题:

可以做一些交互式故障诊断文档,让用户通过标准化吹毛求疵。用户文档会问一系列的问题,并根据用户输入会告诉他们该做什么…这将是一个非常简单的专家系统,或者一个文档状态机。

这个想法将是帮助新人更有条不紊地思考这个复杂的系统故障诊断。

我的问题:

Answer 1

如果你只是想要一个流程图/ stat-machine东西,用户从起点到一组可能的解决方案通过回答问题,然后你可以实现一组wiki页面,可能的反应问题在一个页面上的其他页面的链接。

这个解决方案依赖于能够代表问题的答案链接,这是t上班如果信息表。例如,假设一个问题是“你有什么牌子的显卡?”答案是300个可能的选项之一。在这种情况下它年代烦人的创建链接:)

Answer 2

如果开发人员问的问题太多,我建议让他们自己研究的问题,想出一个答案,然后和你仔细检查,而不是鼓励他们每次都问你。它年代更容易让别人比自己找到答案,但是他们永远不会学习如果他们不寻找自己。

如果用户在问很多问题,那么你可能需要一些用户界面的改进。试着把提示在应用程序本身屏幕的顶部或底部。

两组的用户一个wiki可以帮助。

Answer 3

a FAQ in your wiki
if an error happens too often, try preventing it or output a more useful error message (like "if this happens, the likely cause is that...)