ドキュメントを書こう - メリットと誤解

ポエムです。

ドキュメントを書くことのメリット

1. 時間的制約から解かれる。

• 同じことを何度も言わなくてよくなる。
• その場に居られない人、将来一緒に働く人にも伝わる。

2. 空間的制約から解かれる。

• 良いことを多人数に広められる。
• 他事業所の人にも広められる。

3. 自分にとって

• 浮いた時間でもっと好きなことや新しいことができる。

ドキュメントに依存することの誤解

誤解: ドキュメントに依存してはコミュニケーションの機会が減るのでは？

コミュニケーション、チームビルディングと情報共有は別物。

情報共有は仕事。

例: 〇〇で〇〇のようなトラブルが起こっている。原因は〇〇にありそうで、〇〇までに解決の必要がある。
例: 〇〇の場合には〇〇の承認フローを経てプログラムを修正する。

→皆が均等に必要とする情報

コミュニケーションがむしろできるようになる。

例: 〇〇のこどもが何歳になった。

→皆が均等に知らなくても良い。あるいは、嬉しい話なら何度言っても良い。

誤解: それでも「言ったほうが早い」のでは？

書いておけばもっと早い。

例: 「ここに書いてあるよ。」で、余った時間で雑談できる。

参考

GitLab Communication

等など。以上参考になればさいわいです