既存資産の解説書

混沌とした開発現場では、実にさまざまな問題が起こりますが、その多くは『使えるドキュメント』がないことに起因します。開発者は開発プロセスに従って、必要なドキュメントを作りますが、その後、誰も見ぬまま情報が古くなり、『使えないドキュメント』になってしまいます。なぜなのでしょうか？

「使えるドキュメント」がないことが引き起こしている問題

組込みソフトウェアの開発現場では、生産性や品質の問題が日々深刻さを増しています。その原因はいろいろと考えられますが、『使えるドキュメント』がないことが原因の一つであることは、想像に難くありません。ここでは、その典型的な問題が起こっている｢派生開発｣を例に、どんな問題があるのかを説明します。

「派生開発」では、最初の製品を開発した時に、ほとんどの大きな課題を検討し、その結果としてアーキテクチャが構築されます。しかし、そこで残されるのは、検討のために開かれた会議の議事録（あれば上等）と、検討の結果構築されたアーキテクチャとその説明だけとなってしまいます。

その後の｢派生開発｣では、メンバの多くは入れ替わります。投入された新しいメンバには、構築されたアーキテクチャドキュメントや設計ドキュメント（すでにソースコードと乖離している...）と、ソースコードだけが与えられます。彼らは、与えられたものを元に、最善を尽くそうと試みますが、その背景までを理解することは難しく、時間の制約の中で場当たり的な対応を繰り返してしまいます。その結果、いつの間にか保守性は著しく悪化し、生産性の低下につながってしまいます。

コンサルタントが教える成功の秘訣

エグゼクティブコンサルタント小浜宗隆

現場で必要とされている解説書は、開発対象や現場が置かれている状況などによりまちまちです。そのため、本当に「使える」解説書は、機械的なやり方で導出することは難しく、現場の声を吸い上げて「仕立て」ていく必要があります。つまり、良い解説書を作るためには、お客様の本質的な要望を理解し、開発対象の何が重要かを見極め、それを分かりやすく伝えるスキルが必要となります。

エクスモーションでは、お客様のご要望をお聞きし、それに合った表現方法や進め方をコンサルタントが見極めて、ご提案いたします。

また、作成中は、担当者の方に繰り返しレビューして頂きながら、内容の正確さや分かりやすさを高めていきます。そのようなプロセスを経て作り上げる解説書は、どのような開発対象であっても、きっとご満足いただけるものと自負しております。