他チームへ提供するドキュメントについて

久しぶりに記事を書くのにちっともWebっぽくないことを書きます。
今仕事で作っているドキュメントについて意見があったのでそれをメモ的な意味を込めて。

ドキュメントの目的

今僕はとある大企業のとあるプロジェクトに参画しており、その中でも、開発で使用するツールの（プロジェクトの要件を満たすための）機能検証や、開発者のためのツールの使用方法や機能に関する資料の作成を行うチームのラインに配属されています。

といっても実際に作業をし始めたのは今週からで、ある程度ツールは使えるようになったけど、ベンダの提供するツールの大量で見にくいドキュメントを眺めながら、自分もツールの機能を確認しつつ、開発者向けにわかりやすく丁寧に噛み砕いた資料を作成していっています。

で、僕が最初にラインリーダにどんな資料を作ろうとしてるんですかって聞いたところ、「他チーム（実際に開発を行うチーム）からツールに関する質問をされないようにするための資料を作る」と言っていた。資料の目的としては

• 開発者がツールの使用方法を理解すること
• ツールの機能をわかりやすくまとめること

という感じだと、質問したところこのようにおっしゃっていた。つまるところ「この資料を見ればツールの使い方はわかるんだぜ！だから俺達には聞かないでくれよな！」といった資料を作ることを目的としているようでした。よくよく考えてみると、ん...？と思った。

ドキュメントを見る人の目的

開発をする人はツールを使って、プロジェクトで求められているモノを作る。それが目的であって、ツールを使いこなせるようになることがそもそもの目的であるわけではないので、今回のプロジェクトで使わないツールの機能なんて必要としていない。（ツールの機能のことが詳しく知りたかったらベンダの提供している詳細なドキュメントを見るはず...。） なので、開発者が求めているのは

• プロジェクトで求められているモノを作るためのツールとはどんなものか
• プロジェクトで求められているモノを作るためには、ツールのどんな機能を使うのか
• プロジェクトで求められているモノを作るためには、ツールをどう操作するのか

となると思う。プロジェクトはホントに限られた時間で作業をこなすというのが優先されるためツールに対する視点っていうのは様々なはず。だから、僕たちが作っている資料と開発者が求めている資料って、なんか微妙に違う気がする。

おわりに

以上のことを薄々と思いながら作業してたけど休みに入って思い返すとやっぱり違うなーって思ってきた。大きなプロジェクトって他チームでは、何をやってて何をやろうとしてるかぐらいはメールや進捗のドキュメントを見ればわかるけど、どういった考えで作業してるかって、意外と当たり前のことすら見えていない（見ようとしてない）気がする。メールで情報が毎日飛び交ってはいるけど思いまでは実際に話してみないと伝わらない。社会人になって沢山打ち合わせをしまくってて、どんだけ打ち合わせするんですかって思ってたけど。やっぱり人間同士は話し合わないと思いは伝わらない。そう思った今日この頃。ちょっとチーム間で今一度資料について熱く話し合ってみる必要があるなーと思った。