設計書をカスタマイズする

 2017.05.09  株式会社システムインテグレータ

本連載では、設計書ジェネレータ「SI Object Browser Designer(以下、OBDZ)」を使ってソフトウェアの設計書(仕様書、基本設計書、詳細設計書)を作る講座です。

操作方法を覚えるには、実際に製品を触りながら行うのが一番ですので、 OBDZをお持ちでない方はぜひ評価版をインストールの上、お読みください。 30日間ご利用が可能となっています。以下のURLよりお申込みいただくと、 製品のログインに必要なアカウントを取得いただけます。
https://www.sint.co.jp/products/obdz/trial/trial.html

レポートフォーマットのカスタマイズ

前回、画面設計書を出力するまでの方法をご説明いたしましたが、基本設計書、詳細設計書のフォーマットは標準のものとなっていました。会社のドキュメント標準がある場合は、あわせてレポートの出力項目やデザインをカスタマイズして標準と同じテンプレートにすることが可能です。

今回は例として、「コントロール定義書」をカスタマイズする例でその操作方法をご紹介したいと思います。

1-12393.png

画面1.標準のコントロール定義書

上の画面は標準のコントロール定義書です。コントロール名、表示、種類、データ元テーブル項目などの項目が表示されていますが、今回は以下のカスタマイズをします。
  ・「種類」列を削除
  ・「IME」と「桁数」の順番を入れ替え
  ・「備考」の幅を増やす
また、文字数が長いために表示が見えづらい項目が一部ありますので、セルの高さを増やし、折り返して大きな文字で出力されるようカスタマイズします。

lights.png

既定のフォーマットについて

なお、既定のフォーマットは「DUNGEON」という当社の標準設計フォーマットになっています。 DUNGEONについては、Think ITのサイトに解説記事がありますので、よろしければご覧ください。
http://thinkit.co.jp/free/project/4/1/1.html

まずはじめに、「レポート出力画面」右上にある「設計書設定」ボタンをクリックします。以下の画面が表示されます。

customise

 画面1.設計書設定(一覧)

この中から、カスタマイズしたい設計書の種類を選択します。今回はコントロール一覧をクリックします。以下の詳細画面が表示されます。

customise2

新規CTA

 画面2.設計書設定(基本情報タブ)

基本情報タブでは以下の項目を設定します。

・設計書定義名………レポート出力画面で表示される基本設計書、詳細設計書の種類名を入力します。
・フォームファイル…背景となるExcelファイルとなります。詳しくは後述いたします。
・使用明細………………下部の明細の種類数を選択します。
・設計種別……………基本設計書(外部設計書)なのか、詳細設計書(内部設計書)なのかを選択します。

今回はそのままで構いませんので、以降のタブを変更します。コントロール定義書の場合は既定で「見出部」、「明細部1」、「明細部2」の3つのタブがあります。見出部はシステム名、担当者名などのヘッダーの情報になります。明細部1が表、明細部2が補足説明の情報になります。 今回は表の出力項目をカスタマイズしますので、明細部1を変更しましょう。 

customise3

 画面3.設計書設定(見出部タブ)

明細部1では、表の列構成か変更できます。不要な項目がある場合は、項目行を選択後、上にある削除ボタン(マイナスボタン)で出力項目の削除が可能です。 また、順番を変更する場合は上下ボタンにて入れ替えることができます。 今回は、「種類」列を選択して削除後、「IME」を選択し、下ボタンにて桁数と入れ替えます。

また、今回は実施しませんが、出力項目を追加することもできます。 「表示項目」をダブルクリックするとコントロールの各プロパティ項目がプルダウン表示されますので、 その中から出力したい項目を選択します。 プルダウンの一番下にある「コントロール予備項目1」~「コントロール予備項目10」は予備項目用の設定です。 システム画面にて予備項目を設定している場合は、これらの項目を選択することで、予備項目の値を出力することができます。

なお、間違って設定してしまった場合は、「初期値に戻す」ボタンをクリックすることで戻すことができます。 ただし、デフォルトに戻した後は、変更前の状態に戻すことはできませんのでご注意ください。

次に備考の幅および明細の縦幅を増やします。 幅をカスタマイズする場合は、「フォームファイル」を変更する必要があります。 フォームファイルとは背景の罫線などの背景ファイルのことです。罫線や、セルの表示設定をカスタマイズする場合は、フォームファイルを修正します。基本情報タブの フォームファイルの右にあるダウンロオードアイコンをクリックすると、以下のファイルがダウンロードできます。

3-4.png

画面4.標準のコントロール定義書のフォームファイル

こちらが設計書の背景となるファイルとなります。まず、さきほどと同様に表の1行目にあるタイトルからも「種類」を削除、「桁数」「IME」の順番変更をしましょう。 次に「備考」列を伸ばします。さらに、セルの高さを増やし、複数行で表示されるようにします。 明細部分を範囲選択して右クリック→セルの書式設定→配置タブでセルの表示設定も変更します。 既定では「縮小して全体を表示する」になっていますので、「折り返して全体を表示する」に変更します。

4-1.png

画面5.Excelの折り返し設定

下記のようなフォームファイルになりました。

5.png

画面6.カスタマイズしたコントロール定義書フォームファイル

フォームファイル変更後はOBDZに戻り、 基本情報タブのアップロードボタンをクリックし、Excelファイルをアップロードします。

customise4

画面7.設計書設定(基本情報タブ)

[RELATED_POSTS]

最後に明細部1の「行」「桁」も修正します。 当設定は出力場所となり、項目の追加・削除を行った場合は当設定もあわせて変更する必要があります。 出力位置の設定はフォームファイルを変更後、Excelと照らし合わせながら実施すると効率良くできるため、 最後に実施するのがよいでしょう。

  これですべての設定が完了しましたので、「登録」ボタンを押し、レポート設定を保存してください。 保存後は再度設計書出力画面で出力し、カスタマイズされたことを確認してください。 もし思ったとおりに出力されなかった場合は、再度設計書設定画面に戻り、設定を見なおして下さい。

6.png

画面8.カスタマイズしたコントロール定義書

これでレポートのカスタマイズが完了しました。 今回ご紹介した手順にて、既定の設計書カスタマイズだけでなく、独自の設計書追加など、自由に変更が可能です。 最初に一度実施すれば、今後すべての基本設計書、詳細設計書に反映されますので、ぜひ、しっかりとした実用的な設計書を作成しましょう!

新規CTA

RECENT POST「設計書の書き方講座」の最新記事


この記事が気に入ったらいいねしよう!
ブログ購読のお申込み

RANKING人気資料ランキング

RANKING人気記事ランキング

RECENT POST 最新記事

ITだけCAD使ってない不思議