同じ質問を2回されたら、ドキュメントを書く

同じ質問を2回されたら、ドキュメントを書く

私は、同じような質問を2回されたら、その内容はドキュメント化するようにしています。

対象は技術的な話だけではありません。

こうした内容はもちろんですが、一見すると些細なことでも、複数人が関わるならドキュメント化する価値があります。

例えば、「今日何時に集合ですか?」という質問です。

1対1なら答えれば終わりですが、10人が参加するイベントなら話は別です。

集合時間や場所をドキュメントにまとめて共有しておけば、多くの人は自分で確認できます。同じ質問が何度も飛び交うこともありませんし、情報の食い違いも防げます。

ドキュメントの価値は、それだけではありません。

チャットの回答は、その場限りです。しかし、ドキュメントはURLひとつで共有できます。

半年後でも、3年後でも、「これを見てください」とURLを送るだけで済みます。

しかも、そのURLは自分だけが使うものではありません。質問された人が別の人へ、さらにその人が別の人へと渡していくことができます。

つまり、一度書いたドキュメントは、人を超え、時間を超えて再利用され続けます。

さらに、GitHubなどで管理しておけば、ドキュメント自体を改善し続けることもできます。

質問を受けて説明が足りなかった部分を追記したり、誤りを修正したり、新しい知見を追加したりできます。Pull Requestを通じて他の人が改善を提案することもできます。

ソースコードをレビューして品質を高めるように、ドキュメントもレビューして育てることができます。

AI時代では、この価値はさらに大きくなります。

人だけでなく、AIもドキュメントを参照できます。仕事の進め方、設計思想、FAQ、運用ルールなどが整理されていれば、AIはそれを前提として回答や実装を進められます。

さらに、AI自身が「ここは説明が不足しています」「この情報は古くなっています」と提案し、Pull Requestを作成することもできます。

ドキュメントは、単なるメモではありません。

知識を「検索できる形」にし、「URLで共有できる形」にし、「継続的に改善できる形」に変えるための仕組みです。

「2回聞かれたらドキュメントを書く。」

この小さな習慣を続けるだけで、知識は個人の頭の中から共有資産へ変わります。そして、その資産は人や時間を超えて利用され、改善され続けていきます。

この記事をシェア

関連記事

記事一覧に戻る