nDiki : 形式知

形式知 (explicit knowledge)

2019年10月31日 (木)

トライアル実装について書き出して情報発進するということ

保守が難しくなってきたライブラリを使うのをやめ、まだ導入していない新しいライブラリを使う実験的取り組みをしている担当者に「ドキュメントにまとめておいてほしい」とリクエストしたら「誰が何のために読む想定で書けばよいか」という良い質問をもらった。ドキュメント化で期待する価値について伝えられるよう整理しなおした。

ドキュメント化で期待する価値

今回のトライアル実装のドキュメント化で期待する価値は以下と考えている。

  • 個人の学習: 取り組んでいるメンバ自身の理解が深まる。
  • 資料化: ソースコードから読み取りにくい 「なぜそういう設計・実装にしたか」を今後保守する人が理解するときの助けになる。
  • 組織の学習: 今後同じライブラリを使うことになる組織のほかのメンバが将来参考にできる。

ということで「今のチームメンバ」「将来のメンテナ」「将来の組織の他のメンバ」が読者の想定だ。

「詳細設計書」をまとめるより「今回やったこと」と「分かったこと」「考えたこと」「気付いたこと」(わかき)を整理して書き出すことが、形式知化とナレッジ共有に役立つと考えている。

「ドキュメントにまとめておいてほしい」には「成果物としてドキュメントを残してほしい」だけでなく「情報発信をするメリットを知ってほしい」という思いも含んでいたりする。

[ opinion ]

[ 10月31日全て ]

About

Process Time: 0.068744s / load averages: 0.24, 0.20, 0.18