#4 「ありがたいドキュメント」は繋がっている

「ありがたいなー」と思えるドキュメントはどういうドキュメント？という話です。

優れたドキュメントについては色んな視点があり、「ドキュメントが優れているのは目的にかなっている場合である」というこちらの意見に同意です。

優れたドキュメントは目的にかなっている　“読む目的”を達成させるために書き手が意識したい「2つの品質」

私の職場ではesaという情報共有サービスを利用しています。esaの「とりあえず不完全でも公開し、そのあと何度も更新して情報を育てる」というコンセプトに則った運用をしているため、毎日数十件の記事が作成・更新されています。

沢山の情報がドキュメント化されてありがたい反面、「どっかで見たはずなのに」と目的の記事になかなかたどり着けないことがしばしばあります。そのため、必要なときに必要な情報にたどり着ける工夫がしてある記事には「ありがたい」と感じます。
どのような工夫かと言うと

• エントリーポイントに容易にたどり着ける

• エントリーポイントが必要な記事への導線を網羅している

という至ってシンプルな工夫です。

トラブルシューティングや、急な調査依頼に対応する際など、特定の業務に必要な情報がどこかにあるはずなのにたどり着けないと意味がないですよね。

「ありがたいドキュメント」はそれぞれの情報が繋がっており、その繋がりが容易に見つけられるようになっています。
必要な時に必要な情報にアクセスしたいという読み手の目的にかなっているという点でも、優れたドキュメントとも言えます。

書いて満足するのでなく、活用される状態を作るのも大事という話でした。