エクスモーションが提供する、「解説書」の重要性と開発現場での活用
混沌とした開発現場では、実にさまざまな問題が起こりますが、その多くは『使えるドキュメント』がないことに起因します。開発者は開発プロセスに従って、必要なドキュメントを作りますが、その後、誰も見ぬまま情報が古くなり、『使えないドキュメント』になってしまいます。なぜなのでしょうか？
「使えるドキュメント」がないことが引き起こしている問題
組込みソフトウェアの開発現場では、生産性や品質の問題が日々深刻さを増しています。その原因はいろいろと考えられますが、『使えるドキュメント』がないことが原因の一つであることは、想像に難くありません。ここでは、その典型的な問題が起こっている｢派生開発｣を例に、どんな問題があるのかを説明します。
「派生開発」では、最初の製品を開発した時に、ほとんどの大きな課題を検討し、その結果としてアーキテクチャが構築されます。しかし、そこで残されるのは、検討のために開かれた会議の議事録（あれば上等）と、検討の結果構築されたアーキテクチャとその説明だけとなってしまいます。
その後の｢派生開発｣では、メンバの多くは入れ替わります。投入された新しいメンバには、構築されたアーキテクチャドキュメントや設計ドキュメント（すでにソースコードと乖離している...）と、ソースコードだけが与えられます。彼らは、与えられたものを元に、最善を尽くそうと試みますが、その背景までを理解することは難しく、時間の制約の中で場当たり的な対応を繰り返してしまいます。その結果、いつの間にか保守性は著しく悪化し、生産性の低下につながってしまいます。
なぜ「使えるドキュメント」は開発現場にないのか？
では、なぜ「使えるドキュメント」が開発現場にないのでしょうか？その原因は、次の2点に集約されます。
開発工数・優先順位の問題
近年のような激しい競争が強いられる経営環境においては、いち早く多くの市場を獲得することが最優先の経営課題となっています。そのため、「どこよりも早く製品をリリースする」ために、開発者は何よりも、製品自体の作り込みを優先させられます。
結果として、その時の製品をリリースするための最低限のドキュメントを作るだけで精一杯になります。それには、合意した「結果」だけが書かれ、その根拠や背景については触れられません。つまり、リリース後の派生開発で本当に必要とされる知識はドキュメント化されず、担当者の頭の中に埋もれてしまい、いつしか忘れ去られてしまうのです。
では、ただ時間があれば、「使えるドキュメント」が書けるのでしょうか？
ドキュメントを作成する人のスキルの問題
「使えるドキュメント」を作成するためには、重要な情報を見極め、分かりやすく伝わる形にする必要があります。
そのためには、抽象化能力・論理的思考力・図解力・文章力などのスキルが求められます。それらのスキルは、プログラミングや要素開発などの開発スキルとは異なり、一般的には開発者が苦手としている分野です。そのため、たとえ育成したとしても、満足できるレベルまで到達するためには、かなりの期間と費用を必要とします。
このように、「使えるドキュメント」を作成するためには、ここで挙げた２つの問題に取り組む必要がありますが、開発者をそのまま「使えるドキュメント」の作成者にアサインすることは、現実的な解とは言えません。
「解説書」とは何か？
エクスモーションでは、ここで言う「使えるドキュメント」のことを「解説書」と呼んでいます。
「解説書」とは、開発対象にとって重要なポイントを分かりやすく伝えるドキュメントの総称です。
解説書は、その目的や読者により、複数のドキュメントで構成されます。下図はその一例です。
解説書全体として記載する内容は、ユーザーズマニュアルレベルの要求仕様と、その実現手段であるソフトウェア構造やソースコードとを段階的に結びつけるものであり、開発対象によらず共通です。
しかし、ドキュメントの構成、各ドキュメントの記載内容や記載方法は、それぞれ異なります。
「解説書」に書かれる内容は、その製品の特徴であったり、背景となっている仕組みの解説が中心となります。それらは、一度作成すれば、長い間参照されるものとなります。そのため、一度作ることに大きな意味があるのです。
コンサルタントが教える成功の秘訣
現場で必要とされている解説書は、開発対象や現場が置かれている状況などによりまちまちです。そのため、本当に「使える」解説書は、機械的なやり方で導出することは難しく、現場の声を吸い上げて「仕立て」ていく必要があります。つまり、良い解説書を作るためには、お客様の本質的な要望を理解し、開発対象の何が重要かを見極め、それを分かりやすく伝えるスキルが必要となります。
エクスモーションでは、お客様のご要望をお聞きし、それに合った表現方法や進め方をコンサルタントが見極めて、ご提案いたします。
また、作成中は、担当者の方に繰り返しレビューして頂きながら、内容の正確さや分かりやすさを高めていきます。そのようなプロセスを経て作り上げる解説書は、どのような開発対象であっても、きっとご満足いただけるものと自負しております。
既存資産の解説書の関連サービス
適用支援
解説書作成サービス
お客様からのヒアリングや成果物の中から、埋もれている知識を発掘し、お客様の開発システムに合わせた最適な「解説書」の構成の提案と「解説書」の作成を致します。「抽象化」「整理整頓」の専門家である我々が作成した「解説書」は、永く使われるとともに最良の教科書となりえます。
人材育成
「抽象化」「整理整頓」の基礎力を上げるには、自分の考えを整理する必要があります。本トレーニングは、思考を整理するためのいくつかの方法を、演習を通じて学びます。思考の癖は、1日では直りませんが、最初の一歩を踏み出すには、良いきっかけとなります。
頑張ってるけど、ちっとも楽にならない…何で？
すぐに成果を出すために頑張ってるけど、自前ではもう限界
効果的だろうけど高額なコンサルには手がでない…
あなたに合う一番最適な解決方法を
エクスモーションがご提案いたします。
既存資産の解説書に関する記事を見る
他のソリューションを見る
モデリング プロダクトライン開発
最新コラム
製造業エンジニアのための 生成AI活用スタートガイド
～日常業務への生成AI活用にむけた実践的活用法～ はじめに 製造業のソフトウェア開発現場では業務効率...
SDV時代を生き抜くための サイバーセキュリティ＆機能安全
近年SDV（Software Defined Vehicle）が注目を集めています。SDVではソフト...
設計ノウハウの蓄積と活用を促進する パワエレ製品向けMBSE
パワエレの製品開発では電力・電子・制御など複数の技術ドメインに対する定量値や制約の扱いがシステム設計...
SDVの価値向上に欠かせない データ駆動開発のすすめ
車がネットワークにつながったことで、多種多様なデータを収集することができるようになりました。集めたデ...
