文章は書けてもドキュメントを書けない人はいる。
- 伝わることを意識して書かなければならない。
テキストメッセージではポジティブな感情は伝わらないためネガティブに受け止められがち
- GitLabでは適切なテキストコミュニケーションをするために感嘆符・絵文字を使うと良いとしている。
GitLabは全ては下書きであるという行動原則があり、常に改善していくと宣言している。
かすれた鉛筆は鮮明な記憶に勝る。記憶ではなくドキュメントに残すことが大事だとGitLabは宣言している。
人によって感じ方は違う。日本人は不安を感じやすい方。感情や感覚もドキュメントに含める
コミュニケーションガイドラインを設定する
- 以下は例
- 前向きな意図を想定する
- 優しさが重要
- 自分の考えをインクルーシブに表現する。様々な考えを持つ人が理解できるように
- 直接影響を与えられるものに焦点を当てる。コントロールできない時価総額や景気動向は扱わない
メンテナーを設定して、ドキュメントの品質を保つ。
GitLabでは希望者にGoogleのテクニカルライティングコースを受講できるようにしている

ドキュメントを作成する上で

より良いエンジニアを目指して