GitLabに学ぶ パフォーマンスを最大化させるドキュメンテーション技術 数千ページにもわたるハンドブックを活用したテキストコミュニケーションの作法
千田 和央/伊藤 俊廷/佐々木 直晴翔泳社ISBN 9784798185705
ライティングタグで同率5位(28冊中)。Zenn・Qiitaなどの2記事で紹介(時点)。
- 紹介記事
- 2件
- 媒体別
- 企業テックブログ 2
- 初めての紹介
- 最新の紹介
この本を選ぶ前に
- タグ内の順位
- ライティングタグで同率5位(28冊中・紹介記事数の順)
紹介している記事(2件)
記事ごとの説明は、記事本文のうちこの本に触れた部分をAIが要約したもので、筆者の原文ではありません。
- GitLabに学ぶ パフォーマンスを最大化させるドキュメンテーション技術の紹介 企業テックブログ · 虎の穴 ·
大規模なサービスの開発でドキュメントを書く必要が出て読んだ。GitLabのノウハウを基にドキュメントやテキストコミュニケーションの作り方を扱う本で、「すべては下書きである」という原則とGitLab Handbookに感心したという。品質100%を目指す方法論ではなく、作成の敷居を下げ基本を押さえる内容で読みやすかったとし、対象読者を意識する点が刺さったと述べている。
- リモートワークで活きるGitLabのドキュメンテーション技術 企業テックブログ · 虎の穴 ·
フルリモートの職場でのテキストコミュニケーション改善を目的に本書を読んだ。「すべてのドキュメントは下書きである」という考え方や用語集の整備、Slackで感嘆符や絵文字を使う工夫を参考になった点として挙げている。ドキュメントを書く機会のある社会人、特にリモートワークの人に向くとしている。
この本について
本書は、GitLabの実践を基に、ドキュメント作成とテキストコミュニケーションの原則から具体的な書き方までを解説する入門書である。序章から3章では、ドキュメントの意義や文章作成との違い、テキストでのやり取りに伴う問題、チームで運用するルール作りを扱う。4章から8章では、目的や読者の範囲、可読性などの品質要素と、GitLabの新入社員向けトレーニングに基づく文章作成を学ぶ。9章以降は、ハンドブック、アジェンダ、調査・検証結果を示すレポート、Slackやメールの文面、イシューなど、場面ごとの作成方法を扱う。ドキュメントは作成後も更新する下書きと捉え、対象読者を意識して簡潔かつ正確に書く考え方を示す。
紹介記事と書誌情報をもとにAIが要約したものです。原文の転載ではありません。