新しくチームに来た人向けに何を書いておくか

新しくチームに入ってきた人向けにオンボーディングドキュメントとしてどんなことを書くのか？ イメージとしては、巷のフレームワーク、ライブラリ、ツール、その他諸々でよく見る Quick Start だとか Getting Started な記事があるといいんじゃないかなと思う。いきなりドキュメントここにあるぜドーンでオンボーディングしていくのは難しい。

このドキュメントを読むことで、こんなことがわかると嬉しい、のかな:

• 概要系
  • チームの目的
  • 組織全体におけるチームの立ち位置
  • メンバー
  • よく出てくるステークホルダー
  • 見るべきリポジトリやツールなどの便利リンク集
• 実務系
  • チームのワークフロー
    • 開発の流れ
    • 開発のときに気にすること
  • よく使う各種マニュアル、ガイド
• ファーストステップ系
  • チームの一員になるためにすること
    • どこかのリポジトリで設定をする
    • なにかツールの設定をする
  • 最初のタスクをアサインして、最初のコミット〜最初のリリースまでにやること
    • リポジトリのクローン
    • コードの変更
    • PR作成
    • CI
    • レビュー
    • マージ
    • リリース

この時、記事の中に全部を書く必要はないだろう。それはチームドキュメントとも内容が重複しているはず。 例えばチームのワークフローで「スクラムやってます、進め方はこっち→」のようなかたち。 最初は1記事になるべく全部かいておいて、この話題はちょっと大きすぎるな、となったら分割していくやり方がいいような気がする。最初からきれいさっぱり分割して書いていくのは難しそう。

あとはチェックリストとかで、どこまでやったか、をわかるようにすると更によい。どこまで行っているのかわかりやすいし、自走もしやすい。とは思ったけど、このくらいの量なら1-2日フル稼働したらできそうな気がするので、チームにいる誰かが常にいてあげて質問受け答えやサポートをしてサクッと終わらせちゃうのがよさそう。で、徐々にサポートの量を減らしていって自走してもらう。

…などと、思っていくつかドキュメントを見ていたら、 Kubernetes のドキュメントのような「コンセプト」「リファレンス」「チュートリアル」だなと思った。この分類いいな〜

Kubernetes Documentation | Kubernetes