システムのドキュメントをよりインタラクティブにするにはどうしたらいいですか？

Question

おそらく私が自分のドキュメントをより良くすると、開発者をサポートする時間を短縮し、自分自身を開発する時間を減らすことができます。

私は10人の開発者と50人のエンドユーザーが使用する重要なプラットフォームを開発します。開発者は、ドメイン専門家から相対的に初心者までのさまざまな能力を備えています。私はコアプラットフォームがどのように機能しているのか知っている人のひとりですので、他の開発者からのリクエストは通常​​私を経由します。

私たちのドキュメントは、成熟したプロジェクトにはいつも記述的なものがあります。大規模なwikiには、すべての通常の操作手順と豊富なAPIドキュメントの詳細が含まれています。

標準化されたフォールト発見ルーチンを通じてユーザーを置くいくつかのインタラクティブな故障診断のドキュメントを作成することは可能であろう：タイプの質問に「どのように私は修正しない」ため

残念ながら、それはよく応えていません。ドキュメントはユーザーに一連の質問をし、ユーザーの入力に応じて何をすべきかを指示します...非常にシンプルなエキスパートシステム、またはおそらくドキュメントステートマシンです。

この考え方は、初心者がこの複雑なシステムで障害を診断する方法をより身近に考えるのを助けることでしょう。

私の質問：

• は、ユーザー体験のこの種を実装することを目的と任意の無料ツールはありますか？私はむしろこれをハンドロールしたくないでしょう。対話型ヘルプのためのフレームワークは、ある種のものでなければなりません。&

• 誰もこの種のシステムを実装していませんか？あなただけの質問に答えることにより、可能な解決策のセットに開始点から、ユーザーが移動し、その後、あなたはおそらく、wikiページのセットとしてこれを実装することができフローチャート/ STAT-マシンのものを持っていると思った場合は

Answer 1

あるページの質問に対する可能な回答は、他のページへのリンクです。

この解決策は、質問に対する回答をリンクとして表現できることに依存しています。これは、情報がよりフォームのようなものであれば動作しません。たとえば、「グラフィックスカードのブランドは何ですか？」という質問が1つあるとします。答えは300の可能なオプションのうちの1つです。この場合、リンクを作成するのは面倒です:)

Answer 2

開発者があまりにも多くの質問をしている場合は、質問を自分自身で調査して答えを出してから、もう一度あなたと確認してみてください毎回あなたに尋ねるように彼らに勧めます。あなた自身で答えを見つけるよりも、他の人に尋ねる方がはるかに簡単ですが、自分が探していないかどうかは決して学ばないでしょう。

ユーザーが多くの質問をしている場合は、ユーザーインターフェイスの改善が必要な場合があります。多分、画面の上部または下部にアプリケーション自体にヒントを入れてみてください。

両方のユーザーグループについて、wikiが役立ちます。あなたのwiki内

Answer 3

• よくある質問
• エラーがあまりにも頻繁に発生した場合、この問題が発生した場合は、可能性の高い原因はそれである」のように（もっと便利なエラーメッセージを、それを防止または出力してみてください...）