保守が難しくなってきたライブラリを使うのをやめて、まだ導入していない新しいライブラリを使う実験的取り組みしていている担当者に「ドキュメントにまとめておいて欲しい」とリクエストしたら「誰が何のために読む想定で書けばよいか」という良い質問をもらった。質問を受けてドキュメント化で期待する価値について伝えられるよう整理しなおした。 ドキュメント化で期待する価値 今回のトライアル実装のドキュメント化で期待する価値は以下と考えている。 個人の学習: 今回の取り組みメンバの理解が深まる。 資料化: ソースコードから読み取りにくい 「なぜそういう設計・実装にしたか」を今後保守する人が理解する時の助けになる。 組織の学習: 今後同じライブラリを使うことになる組織の他のメンバが将来参考にできる。 ということで「今のチームメンバ」「将来のメンテナ」「将来の組織の他のメンバ」が読者の想定だ。 「詳細設計書」をまとめるより「今回やったこと」「分かったこと」「考えたこと」「気付いたこと」を整理して書き出すことが、形式知化とナレッジ共有に役立つと考えている。 「ドキュメントにまとめておいて欲しい」には「成果物としてドキュメントを残して欲しい」だけでなく「情報発信をするメリットを知って欲しい」という思いも含んでいたりする。 すべての情報を共有する。情報閲覧者が判断する。 私が情報発信を勧める理由 「わかき」分かったこと・考えたこと・気付いたこと [ opinion ]