🙆‍♀️

GitLabに学ぶパフォーマンスを最大化させるドキュメンテーション技術〜第1部〜

2025/01/05に公開

Daily Blogging15日目
「GitLabに学ぶパフォーマンスを最大化させるドキュメンテーション技術」読み始めた。
世界65カ国以上にまたがる2000名以上のメンバーが在籍しているフルリモート企業におけるドキュメンテーションの方法について細かく説明してくれてる書籍。
第1部、第2部で構成されてる。
第1部では、なんでドキュメントが必要なのか、どういうドキュメントの管理の仕方をしているのかなどを解説
第2部では、ドキュメントの書き方について解説している。

とりあえず第1部読んだのでそのアウトプットをしていくぅ

なんでドキュメントが必要なんだ

簡単にいうと、組織における「共通認識」をちゃんと作り出すこと。
※本では「共通のリアリティ」って言ってる

えっ?それだけの理由?って思っちゃった
でもこの「共通認識」を作るって組織で動く上ではめちゃくちゃ重要なんだよなぁ
普通に働いてる上で、認識齟齬なんてよくあるし、判断基準が結構人によってバラバラだったりしてそれが組織としてのパフォーマンス下げる要因の1つになってる。

プロセス・ロス

複数人集まることによって逆にパフォーマンスが下がる現象がある。
このことを「プロセス・ロス」っていう。
→認識がずれていたり、共通の判断基準がないことが原因でのコミュニケーション不足とかで起こる
GitLabはこの「プロセス・ロス」をドキュメンテーションによって防いでいる。

なんで認識のずれが起こるんだい

まぁこれは色々理由がある。
本ではこの認識のずれが発生する原因をまぁ細かく書いてる。
これは本を読んで確認してください。
めちゃくちゃざっくりいうと、「バイアス」が原因
このバイアス、めっちゃ種類ある。なんか9個くらい紹介してる。

ドキュメントの注意点

本読んでて感じたドキュメントを作る時の注意点3選

  1. 読者を意識する
  2. ドキュメントは「下書き」
  3. SSoT

読者を意識する

「良いドキュメント」っていうのは、そもそも読んでもらえる、誰が読んでも認識齟齬が生まれない。
小難しい言葉だったり曖昧な言葉を使うと、認識齟齬が生まれやすいし、なんか読む気なくす。
ドキュメントを作るときは、まず読者をちゃんと想定することが大事。
もっと言えば、読者の「読解力」を意識することが重要。
一般的に言えば、誰でも問題なくスラスラ文章を理解するには、中学2年生くらいの文章で書くといいらしい。
だからドキュメント書く時にはそれくらいの気持ちで文章をまとめると良い。

ドキュメントは「下書き」

ドキュメントって書いて終わりじゃないんですよね
状況によって常に更新されるものだし
だからこそドキュメントは「下書き」なんだという認識を持つことが重要。
そしてドキュメントを形骸化させないためにも、ドキュメントのメンテナーが誰なのかもちゃんと明らかにしておくことが大切。
ちゃんと責任の所在を明らかにしておこう。

SSoT

これ初めて聞いた。
「single source of truth」の略で、情報システム設計の考え方らしい。
要は、信頼できる唯一の情報源とすること
情報があちこちにバラバラになったり、同じような情報がそこらじゅうにあるような状態にせず、しかも常に最新の情報が掲載されているような状態にすること。
つまり、ここさえみておけば問題なし!っていうドキュメントにすることが大切。
こうすることでドキュメントの信頼性も上がるし、社員もまずこのドキュメントを見にいくようになるので形骸化もしていかない。

ドキュメントが形骸化する一番の理由って、「信頼性」がないことなんだよな
いつ書いたかもわかんない、なんだったらすでに退職した人間が作成してそれっきりみたいなドキュメントめちゃくちゃあるけどそんなもん見る気もしない

感想

「仕組み化がすべて」と結構言ってること近いかなって思った。
根本的に考えてることは同じ気がしていて、どちらも
「社員の行動、判断基準を統一する」っていうことを重要視しているのかなと
キーエンスもGitLabもそれを「ドキュメント」でちゃんと明文化して組織に根付かせてる。

The GitLab Handbook

ちなみにGitLabのドキュメントは全て外部に公開されているので誰でも見れる。
The GitLab Handbook

Discussion