最近、ドキュメント書いていますか？

2015.03.13 Shindo

最近、ドキュメント書いていますか？

私、書いてます。

そもそもプロジェクトマネージャという役割上、品質マネジメントに関するドキュメントを書く必要あるのですが、この業界でのこれまでの経験を振り返ってみても、実装経験はわずか４年程度ですから、ドキュメントを書くことに多くの時間を費やしてきました。

ウォーターフォールの時代

実装経験を積んだ４年間を振り返ると、当時はウォーターフォール開発が主流であったこともあり、詳細設計書を記載し、レビューを経て承認をもらえないとプログラミングをさせてもらえませんでした。

納期が気になりだすと、「仕様はわかっているから、プログラミングさせてくれ。。。」と思うのですが、仮に設計書の承認前にそんなことをしようものなら、上司に大目玉をくらうような状況でした。

時代は変わり

時代も変わり、ユーザの要求の変化に応じるためにアジャイル開発を取り入れるプロジェクトが多くなってきたと思います。

では、アジャイル開発だとドキュメントを用意しなくて良いのでしょうか？

答えはNo.です。

アジャイル開発といえば部分的に機能を切り出して開発し、少しずつユーザの要件を確定させながら進めていくことを目的としますので、まずプログラミングして機能を見てもらうことは重要です。

例えば、画面デザインは、ユーザが直接見て、操作するものですから、見た目の綺麗さ、見易さ、操作感は早く確認してもらう方が得策です。

画面間で共通に使用するポリシーなど最低限のことが決まれば、実装しちゃいましょう。

（画面がFIXしたら、キャプチャを取得して最終化するのを忘れずに。）

重要なこと

開発手法が変わっても、ドキュメントに対する位置付けは変わっておらず、重要なのは、

・何を

・何の目的で

・適切な表現方法、適切な細かさ・深さで

・誤りなく

・いつ作る

だと思っています。

でも、言うのは簡単で、実際に書いてみるとなかなか難しいですよね。

これまでもドキュメント作成のガイドラインを用意しようとしたことはありますが、あくまでもガイドラインであり、正解とは違います。

正解を見つけるために、日々プロジェクトの経験を積み、その正解を部分的にでも見つけられたら、ブログに書いてみようと思います。

最後に、ドキュメントを書くときにいつも心がけていることを書きます。

「何年か後に、誰かが必ずこのドキュメントを見る。その誰かへのメッセージだと思って書こう。」