@hihihiroroのLog

ダラダラと。本ブログは、個人の意見であり、所属会社とは関係がありません。

「GitLabに学ぶ パフォーマンスを最大化させるドキュメンテーション技術」を読んだ

ドキュメントが大事と言うのは分かっている。だけどうまく書けなかったり、書いたけど更新がうまくされてないということがよくあるのでなにか解決策はないかなと呼んでみた。

本書は前作 GitLabに学ぶ 世界最先端のリモート組織のつくりかた の続きのようである。
ちなみに前作を読んだときの感想はこちら。

hihihiroro.hatenablog.com

目次は以下。

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

前作でも非同期でのチームの働き方として、ドキュメントの大切さがたくさん説明されていた。今作ではその大事なドキュメントをいかに作り上げていくかについてが説明されていたように思います。
本書の中では文字のやり取りとして「テキストコミュニケーション」と「ドキュメント」の2種類が紹介されている。
テキストコミュニケーションはタイムリーにやり取りができるが情報としてはどんどん流れてしまうもの。ドキュメントは賞味期限長く蓄積をするためのものとなっている。ドキュメントにならないことを防ぐためにSlack の内容は90日で削除される設定になっているなど徹底されているなと感じた。

テキストコミュニケーションのポイントとしては以下が紹介されている。

  • オープンな場でやり取りを行う
  • リアルタイムにやり取りを行う
  • 端的にわかりやすくやり取りを行う

その際に大事なのは、感情がわかるような書き方を心がけるや、言葉は書き方などで人を簡単に傷つけることを忘れないようにすることなのだと思う。このあたりをすぐに忘れてしまって後悔することが多々あるので忘れないようにしたい。会社でも文章が怖いと言われることがある。

そしてドキュメントについては次のことを考えて書くことが大事そう。

  • ドキュメントは信頼できる唯一の情報源(SSOT) である
  • すべてのドキュメントは下書きである

ドキュメントが正しいとわかっていれば調べ先として困ることもないし、判断に迷うことも少なくなる。そのため、必要なドキュメントは次々と記載をする必要がでてくるためどんどん充実していくのだろう。
下書きだと考えることで書くための抵抗を減らされる、更新がいつまでも続けられるのかもしれない。ドキュメントと言われるとしっかりしてないといけないとよく考えてしまうが、確かに下書きだろうが、メモ書きだろうがとりあえず文字として書き出しておくことをしておきたいと思った。

「テキストコミュニケーション」でも「ドキュメント」でも大事なのは、それを読む他人がいるということを考える必要があると感じた。
無駄なやりとりをすることや、読みにくい文章を読ませることで読んでくれる人の時間を無駄にしないことを原則として考えていきたいと思う。
うまく伝わらないことでイライラすると感じていたが、それは自分がわかるように書けてないことが問題なのでわかりやすい文章の書き方や言葉遣いを使うようにしていきたい。

本書の中ではいくつか見ておきたいリンクが紹介されていたので見てみようと思う。

handbook.gitlab.com

handbook.gitlab.com

developers.google.com

まとめ

  • 頭の中身を見えるところに出していくようにする
  • その際の記載内容、記載方法については相手のことを考える
  • 個人だけではどうにもならないのでグループ内に共有をしていく