1. HOME
  2. ソリューション
  3. 解説書とは何か?

解説書とは何か?

「解説書」とは何か?

エクスモーションでは、ここで言う「使えるドキュメント」のことを「解説書」と呼んでいます。

「解説書」とは、開発対象にとって重要なポイントを分かりやすく伝えるドキュメントの総称です。

解説書は、その目的や読者により、複数のドキュメントで構成されます。下図はその一例です。

解説書全体として記載する内容は、ユーザーズマニュアルレベルの要求仕様と、その実現手段であるソフトウェア構造やソースコードとを段階的に結びつけるものであり、開発対象によらず共通です。

しかし、ドキュメントの構成、各ドキュメントの記載内容や記載方法は、それぞれ異なります。

「解説書」に書かれる内容は、その製品の特徴であったり、背景となっている仕組みの解説が中心となります。それらは、一度作成すれば、長い間参照されるものとなります。そのため、一度作ることに大きな意味があるのです。

「派生開発」など組込みシステムの開発現場における『使えるドキュメント』が『解説書』であり、開発対象にとって重要なポイントを分かりやすく伝えるドキュメントの総称【システムレベル】システム全体の構成・システム全体の振舞い・ECU間 協調制御「システム概要」システム全体の概要把握・開発対象の位置づけ把握⇒社内報告会等「協調制御概要」複数ECU協調制御の概要把握⇒他部署とのレビュー用資料等【ソフトウェアレベル概要】制御の全体構成・制御全体の振舞い「制御概要」開発対象制御ソフトウェアの概要把握⇒他部署への説明、追加メンバ用の導入資料等【ソフトウェアレベル詳細】機能・目的・要求・制約・入出力RAM/適合定数・制御仕様「制御設計書」制御ソフトウェアで実現したいこと、実現方針、背景などを把握⇒いわゆる制御仕様書、モデル検証の入力等「データ定義」「定数定義」「Simulinkモデル」既存ドキュメントは(あれば)そのまま活用

頑張ってるけど、ちっとも楽にならない…何で?

すぐに成果を出すために頑張ってるけど、自前ではもう限界

効果的だろうけど高額なコンサルには手がでない…

あなたに合う一番最適な解決方法を
エクスモーションがご提案いたします。

既存資産の解説書の関連サービス

適用支援

解説書作成サービス

お客様からのヒアリングや成果物の中から、埋もれている知識を発掘し、お客様の開発システムに合わせた最適な「解説書」の構成の提案と「解説書」の作成を致します。「抽象化」「整理整頓」の専門家である我々が作成した「解説書」は、永く使われるとともに最良の教科書となりえます。

「抽象化」「整理整頓」の基礎力を上げるには、自分の考えを整理する必要があります。本トレーニングは、思考を整理するためのいくつかの方法を、演習を通じて学びます。思考の癖は、1日では直りませんが、最初の一歩を踏み出すには、良いきっかけとなります。

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

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

最新コラム