誰が解説書を書くべきか？

誰が「解説書」を書くべきか...？

解説書を具体的に見ていただくと、こんな疑問が出てきたかもしれません。

誰が「解説書」を書くべきか...？

解説書に記載している内容は、比較的一般的な知識に基づくものもあれば、高い専門知識に裏付けされたものもあります。そのため、やはり開発者自身が作成するのが適しているのか、というように思われるかもしれません。ただ、前述のように、開発者がドキュメントの作成時間を捻出することは難しいうえ、「使えるドキュメント」の作成スキルと開発スキルは異なります。

そこをカバーできるのが、開発現場主体で活動している、コンサルタントの存在です。

エクスモーションのコンサルタントは、お客様の開発現場で、お客様と一緒になって問題解決にあたります。そのため、組込みソフトウェアの経験が豊富にあり、どんなシステムでも、多少の時間をかければ、ある程度専門性の高い知識であったとしても理解することができます。また、そもそも「抽象化」「整理整頓」はコンサルタントのコアスキルであり、得意分野です。その両方を兼ね備えているからこそ、かゆい所にまで手が届くドキュメントを作ることができるのです。

一方で、開発者は専門家に解説書作成を任せてしまうことで、本来の開発業務に専念することができます。更に、いったん「解説書」が完成すると、最良のドキュメンテーションのお手本を得ることができるのです。お互いが、お互いの得意分野に専念し、協力し合うことで、最高の成果を残す。まさに「餅は餅屋に任せろ」というわけです。

皆さんも、一度、解説書の作成を検討してみてはどうでしょうか？

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

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

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

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

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

既存資産の解説書に関する記事を見る

他のソリューションを見る

最新コラム