虎の穴ラボのkamimuraです。
翔泳社より2024年12月に出版された「GitLabに学ぶパフォーマンスを最大化させるドキュメンテーション技術」を読みましたので、紹介させて頂きます。

読み始めた経緯

虎の穴ラボ入社前は小〜中規模いかないくらいのシステムやアプリを複数一人で担当することが多く、システムの全体像も大体把握できていました。そのため、ディレクターさんとの打ち合わせで要件を決めたら後は必要な作業もほぼ見えており、タスク化して進めるだけで事足りていました。
しかし「Fantia」はサービスが大きく関係者も複数おり、これから行う開発についてブレが無いようドキュメント作成も必要になります。
しばらくドキュメント作成をしてこなかったので本書で学べたらと思い読み始めました。

書籍情報

項目	内容
著者	千田和央
発行日	2024/12/09
ISBN	9784798185705
ページ数	280ページ
価格	1,980円(税込)

www.shoeisha.co.jp

本の概要

書籍の公式ページより引用させて頂きます。

本書は、世界でも有数のドキュメント作成ノウハウを持っているGitLabを参考にした「ドキュメント作成」や「テキストコミュニケーション」の入門書です。
同社は、世界65カ国に2,000名を超えるメンバーが所属しているグローバルカンパニーです。
世界中のあらゆる場所や価値観、タイムゾーンに存在するメンバーのパフォーマンスを引き出すためには、ドキュメントが鍵であると同社は述べています。
情報が蓄積されたドキュメントが存在することで、必要な情報にいつでも多くの人がアクセスでき、信頼性の高い情報をベースに業務が進められます。
本書では、このような効果的なドキュメントがどうすれば作成できるのか、GitLabのドキュメント作成ノウハウに基づいて解説します。
また、GitLabのドキュメント作成方法はかなり具体的なルールや手法が示されていますが、その背景にある理論や研究についても触れることで、表面的な理解だけでなく根本の思想についても学習し、応用できるように説明します。

書籍の内容

簡単に書籍の内容を紹介します。
まず目次は下記となります。


序章	ドキュメントについて知る
1章	世界最先端のリモート組織を支えるドキュメント
2章	ドキュメントを組織に導入する必要性
3章	基本となるドキュメント作成スキルを身につける
4章	ドキュメントの影響範囲と品質
5章	GitLabのテクニカルライティングトレーニング
6章	Valueを活用してライティングスキルを向上させる
7章	メッセージの組み立て方
8章	メッセージの表現方法
9章	ハンドブックのドキュメント作成
10章	アジェンダの作成
11章	レポートのドキュメント作成
12章	Slackのテキストコミュニケーション
13章	メールやコンテンツのテキストコミュニケーション
14章	イシューの作り方

本書籍は単なるこうすれば良いドキュメントになる、といったHowTo本ではありません。
GitLabというあらゆる国籍のメンバーが所属する企業で、フルリモートでドキュメントやテキストコミュニケーションを活用して仕事を進めるノウハウが紹介されています。
また、そもそもドキュメントとは何のために作るのか、ドキュメントの価値といった根本の部分にも踏み込んで説明されています。
GitLabはフルリモートで世界中にメンバーがおり、それらをつなぐのがドキュメント、テキストコミュニケーション、そしてたった1つのGitLab Handbookです。
GitLab HandbookにはGitLabのあらゆることが集約されており、GitLab Handbookの内容が公式見解であり、意思決定の基準であり、信頼できる唯一の情報源と呼ばれています。
このようなスタイルに至る過程や、GitLab社内でどのようにドキュメントやテキストコミュニケーションが活用されているか解説されています。

序章から3章
ドキュメントの意義、文章が書けることとドキュメントが作成できることの違い、テキストコミュニケーションは傷つきやすいという問題提起、GitLabがどのような過程を経てチームで運用するためのルール作りを行なってきたかを解説しています。
ここではドキュメントやテキストコミュニケーションを活用するための前提として何を守るべきか、どのような仕組みが必要か知ることができます。
4章から8章
ドキュメントを作成する上で共通の原則を押さえ、実際にGitLabが新入社員向けにトレーニングしている内容を踏まえて学んでいきます。
目的、読者の範囲、可読性等のドキュメントに必要な要素の押さえ方、実際に文章を作成する方法を学ぶことができます。
9章から最後の14章
シーン別のドキュメント作成へ対応する方法について書かれています。
会議を効率化し後から議論の内容を確認するためのアジェンダの書き方、なんらかのテーマに対し調査・検証した結果を示すレポートの書き方、メールやテキストコミュニケーションの書き方と注意点を得ることができます。

感想

「すべては下書きである」
この行動原則は良いと思いました。サービスと同様、ドキュメントも作って終わりではなく更新を続けていく、またそれを推奨する環境が意識を高めていく。
作成する際も対象読者は社内全員と考えると、簡潔で正確に必要事項を伝える必要があるので書く能力も高まりそうです。
GitLab Handbook
内容が公開されていて、少し覗いただけですが本当に全て集約されているんだと驚きました。
資料が散逸せず、更新されないことを防ぎ、1つの情報源から検索できるのは非常に効率的そうですが...単純な真似は難しそうで、維持する文化作りも含めて横断的な導入が必要になるのかなと。
The Handbook | The GitLab Handbook
ドキュメント作成はカジュアルに学習できる
本書籍はドキュメントを品質100%に仕上げることを目指す方法論を語るのではなく、作成に対する敷居を下げてどのような基本を押さえるかがメインになっています。
GitLabでの運用方法とセットで学べることと書籍自体が非常に読みやすい流れになっていて理解し易かったです。