輪読会から始めるドキュメント整備への取り組み

はじめに

こんにちは!エキサイト株式会社のまさきちです。 開発チームで「ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング」という書籍で輪読会を行いました。 輪読会を行うことで得た学びをシェアいたします。

輪読会を始めたキッカケ

以前、開発プロジェクトのふりかえり会でドキュメント整備に次のような課題があることが判明しました。

  • フォーマットやまとめ方が統一されていない
  • 機能によってはドキュメントが存在しない
  • ドキュメントを見つけるまでに時間がかかる

tech.excite.co.jp

カイゼンに向けてのネクストアクションとして、ドキュメントの書き方や運用方法を学び実践しよう!という話になりました。 学ぶ手法として輪読会を行う事に決まりました。

実践方法

最初に輪読会の目的や進め方を話し合い、ルール決めしてから始めました。

開催頻度

開発メンバー3人で、月曜日と金曜日の週2回で各回30分程度で行い1回の輪読会に対して1章読み進める形で行いました。

進め方

事前にMiroを使って思ったことや参考になりそうな事を付箋に書き出し、輪読会は共有と意見交換メインで進めました。 ある程度読み進めた段階で、アウトプットのために実践する会も設けました。 ファシリテーターや共有する順番も会ごとに変えるなどマンネリ化しない工夫をしました。

学び

ドキュメントを作る前に誰のどのような課題を解決したいかを明確にすることが重要で、まず読み手に対しての深い理解が必要だということを再認識しました。 現状の現場のドキュメントの状態と書籍で紹介されているドキュメントの書き方や管理方法について比較することで、課題や改善点について洗い出すことができました。 ドキュメントを書いた後フィードバックを求める文化が無かったので、これからは積極的にフィードバックを貰ってカイゼンし続けようと思います。

ふりかえり

輪読会のふりかえりも行いました。

good
  • 定期的に集まってみんなで考える時間が取れたのは思考が深まった
  • 漠然とした「わからないからドキュメント欲しい」を言語化できた
  • ジャーニーマップは大変だったけど、課題感をより把握できた
  • 読みと実践を両方やったところはより理解度が進んだ
more
  • 輪読会を終えるまで3ヶ月かかってしまい、中弛みを感じた
  • Miroだけだと決定事項や学びが後から追いづらいので議事録や一覧で確認できるドキュメントが欲しい
  • 必要最低限の章だけ読めば長引かずに済んだかも

アウトプット

新規ドキュメントを書くためテンプレートを作り、記述項目を合わせることでフォーマットを統一して欲しい情報が探しやすいようにしました。 主要機能のドキュメントを輪読会メンバーで1つ作成して、カイゼン後のドキュメント記述の実例を示すことができました。 今回の取り組みを事業部の開発チームに共有して、ドキュメントの運用を見直しました。

まとめ

輪読会をして終わりではなく、ネクストアクションに繋げてアウトプットできて良かったです。 ひとりで読み進めるより、チームメンバーの意見を聞けたり認識の共有ができました。 ドキュメント運用に対しての具体的な課題が浮き彫りになり、解決方法を考えてカイゼンして成果を出す事が出来ました。

今後も開発組織のプレゼンス向上のための活動をしていきたいと思います。