書籍名「Gitlabに学ぶ。パフォーマンスを最大化させるドキュメンテーション技術」
翔泳社
著:千田和央
監修:伊藤俊廷/佐々木直晴
本稿の目的
・読んでいて、印象に残った箇所を記録するため
対象読者
チーム開発で認識のズレに課題を感じている人
読もうと思った動機
・「GitLabに学ぶ 世界最先端のリモート組織のつくりかた ドキュメントの活用でオフィスなしでも最大の成果を出すグローバル企業のしくみ 」を元々読んでいて、その新作が出たとのことなので 読もうと思いました。
印象に残った部分
p3 はじめに
「ドキュメント」と「テキスト」という素晴らしいツールを持っているにもかかわらずそれを使いこなせない状態にある。
→うまく使いこなせれば、時間や場所価値観の違いを乗り越えて、コラボレーションすることが可能になる。
p24 GitLab Hand
ドキュメントの作成コストは高いという暗黙の内に考えられている。
そのため済ますこと多い。
ドキュメント作成のコストの大半は、
「頭の中にあるアイディアを言語化すること」
「文章構成を構想すること」に割かれている。
p39 ドキュメントの大きな価値
ドキュメントがあることで「人と人がわかり合える」
p44 gitlab handbook
・公式情報はハンドブックのみ集約するというルールを定めています。
・「信頼できる唯一の情報源」(SSOT = Single Source Of Truth)
・「すべては下書き」という行動原則がある。より良い判断基準や記述が見つかれば常に改善を続けていく。
p46 ライブドキュメント
・参加者全員がミーティングしながら記載するという方法、話された内容をもれなく記録することができる
p52 かすかな鉛筆は鮮明な記憶にまさる
・技術や知識がすべて口伝で行われていたとしたら誤って伝わってしまったり、
何らかの事故で失われてしまったりすることもあるかもしれません。
・ドキュメントという客観的な場でお互いの情報をアウトプットして、確認し合うことが効果的なのです。
p53 パフォーマンスの非効率
以下のような問題は、実はドキュメントによってほとんど解決できます。
・社会的手抜き
個人がチームで作業をするときに、一人で作業するときと比べて手をぬきやすくなってしまう減少
・損失の調整
他の人との調整を行う際に発生する損失のことです。
p89 ドキュメントが無いことによるコスト
・アクセスしづらい
・透明性がない
・信頼性が低い
・記録性が低い
実践できること or 感想
感想
・今私が直面している問題についてよく書かれておりとても勉強になりました。
私も実務上ではドキュメントを書けていません。原因としては、以下が考えられます。
・書く時間がない
・学習コストが高い。身近にレクチャーできる人が少ない(忙しい)ので教わることができない。習得方法が独学になる。
ドキュメントがないことによる弊害は
・実装ミスが発生し手戻りが発生する
・仕様が曖昧になり、コミュケーションを何度も繰り返す
書きにくい環境だとしても、それでもやりようはあるとは思いますね。
実践すること
・Googleのテクニカルライティングコースを受講する。
・GitLabのテクニカルライティングコースを受講する。
・社内打ち合わせでライブドキュメントで議事録を取る
カレンダーに議事録のURLを加えておく