虎の穴ラボ技術ブログ

虎の穴ラボ株式会社所属のエンジニアが書く技術ブログです

MENU

リモートワークで活きるGitLabのドキュメンテーション技術

はじめに

こんにちは!虎の穴ラボのnagaです。
フルリモートワークの弊社では、テキストコミュニケーションの機会が多いです。今回はより良いテキストコミュニケーションを目指して、下記の書籍を読んでみたのでご紹介します。

書籍の紹介

項目 内容
タイトル GitLabに学ぶ パフォーマンスを最大化させるドキュメンテーション技術
著作者名 千田 和央
ページ数 280ページ
発売日 2024/12/09
ISBN 9784798185705

www.shoeisha.co.jp

概要

本書は「GitLab」社で実践されているドキュメンテーション技術やメール・Slackでのテキストコミュニケーションについて解説されている書籍です。 「GitLab」社は世界中にメンバーが存在しているリモートワーク企業のため、ミーティングなどを同期的に実施することができません。そこで「GitLab Handbook」にあらゆる情報を集約して情報共有を行なっています。
本書では世界中のメンバーと連携を図り、高いパフォーマンスを維持するために、どのようにドキュメントを活用・作成しているのかを具体的に示しています。

序章ではドキュメント作成の基礎知識として、読解力の個人差やテキストコミュニケーションが人を傷つけやすいことに触れ、意図通りに伝わるようにトレーニング可能であることを紹介しています。

その後は3部構成になっています。第1部では「GitLab」社でどのようにドキュメントを活用しているか、またその思想について解説しています。第2部では実際にドキュメントを作成するためのスキルを解説しています。第3部ではミーティングのアジェンダ・レポートなどのドキュメント作成やSlack・メールでのテキストコミュニケーションについて解説しています。

対象読者

ドキュメントを書く機会があるすべての社会人におすすめの書籍です。 特にリモートワークによってテキストコミュニケーションの割合が多い方は、本書から得られるものが多いと思います。

感想

ドキュメント作成と保守について

「GitLab」社ではドキュメント作成における多くのルールが決まっていたりテクニカルライティングのトレーニングを受けることができるため、アウトプットするハードルが下がっていると感じました。特に「すべてのドキュメントは下書きである」という考え方は、継続的にドキュメントをアップデートする意識にも繋がっていると思います。
この考え方により、以下の課題も回避することができるため、社内向けにドキュメントを書く際には同じ意識を持とうと思いました。

  • 上司からドキュメント作成を依頼されて完成後に提出したが、求められていたドキュメントになっておらず大きな手戻りが発生した。
  • 一度作成したドキュメントがメンテナンスされず使い物にならない。

用語集について

システム開発と同じようにドキュメント作成においても用語集を整理することが大切だと分かりました。あるドキュメント内ではAという用語で統一しているが、他のドキュメントではBという用語を同じ意味で用いている……という状況では勘違いが発生する可能性が高まります。チームにメンバーが着任したケースでも有用なので、少しずつ私のチームでも整備したいと思いました。
さらに「GitLab」社では誤用されやすい用語のリストを作成しているそうです。たとえば「自分たちのことをリソースと呼ぶのではなく、人々と呼ぶ」といったものです。意図せず組織のイメージを低下させる可能性があるため、こちらも合わせて整備してみたいです。

Slackでのコミュニケーションについて

弊社のメンバーは自然と実施していることですが、感嘆符「!」や絵文字を使ったコミュニケーションが良いとされていました。
本書でも述べられていましたが、文章でのコミュニケーションでは表情や声のトーンが分からないため、ネガティブに受け止められやすいです。 私もシンプルな句読点だけの文章を受け取った時に、怒られているように感じたことがあります。
こうした良い取り組みは継続したいと思いました。

最後に

今回は「GitLabに学ぶ パフォーマンスを最大化させるドキュメンテーション技術」という本を紹介しました。 ドキュメント作りやテキストコミュニケーションの改善に役立つヒントが満載の1冊です。 気になっている方はぜひ読んでみてください!

採用情報

虎の穴ラボでは一緒に働く仲間を募集中です!
この記事を読んで、興味を持っていただけた方はぜひ弊社の採用情報をご覧ください。
toranoana-lab.co.jp