株式会社ZeroDivide - Trinity製品情報
~設計書の自動作成について特徴をご紹介します。~

ソフトウェアの作成や変更を行う場合、設計書についても作成や変更を行う義務があります。しかし実際にソフトウェアと設計書の同期が取れている開発現場は少ないのが実情ではないでしょうか?

このような問題への一つの回答が「設計書の自動作成」です。自動作成では既存のメンバーソースから設計書を作成しますので、設計書は最新のソースと同期が取れています。また自動作成のため、作成自体に手間がかかりません。

システム全体を俯瞰するためにも、「Trinity」を使って設計書の整備を行ってみてはいかがでしょう?

特徴
成果物としての設計書
設計書を「納品物」や「監査用の資料」として捉えた場合、ファイリングにも耐えられる印刷品質が求められることでしょう。もちろんスプールファイルのようなキャラクターベースそのままの出力では設計書と呼べる代物ではありません。

「Trinity」ではWindowsの描画機能を生かした見栄えの良い印刷が行えますので、一般的なワープロソフトで作成された設計書と比較しても、なんら遜色の無い出力結果を得ることができます。

また階層構成図やファイルレイアウトなどのように一般的なワープロソフトでは作成が困難な設計書についても、独自の技術を用いることで簡単に作成を行うことができるようになっています。

特徴
日本語コメントの活用
「Trinity」はソース上に存在する日本語コメントを積極的に活用します。

例えば行コメントや同行コメント、ファイルDDSのCOLHDG句やTEXT句に代表されるキーワード、 メンバーリストに設定されている日本語名称など、様々な情報源から日本語情報を取得し、設計書の自動作成やソフトウェア資産の解析作業に役立てています。だからこそ単純なリバースエンジニアリングとは一線を画す、質の高い設計書を作成できるわけです。

また設計書の見出し情報の設定については2つの方法を用意してあります。一つは「可変ヘッダー」と呼ばれるもので、これはソースの先頭に存在するコメントブロックからキーワードとセパレータを元に日本語名称や作成日時、システム名称などを取得する方法です。 可変ヘッダーを使用すると、従来どおりのブロックコメントからソース固有の情報を取得することができます。

もうひとつは「固定ヘッダー」と呼ばれるもので、これは可変ヘッダーで取得できなかった場合の標準の見出し情報を設定するための方法です。例えば作成日時や作成者などを固定ヘッダーに入れておけば、可変ヘッダーでそれらの項目を設定できなかった場合に値を設定することができます。

特徴
多彩な設計書様式
多彩な設計書が用意されています。

Trinityで自動作成された設計書は画像のようなイメージとして保管されているわけではなく、専用の中間形式で保管されています。印刷や閲覧を行う場合には自動作成された中間形式のファイルと設計書様式を組み合わせて「設計書」として出力を行います。 この時に使用される設計書様式のことをTrinityでは「原紙」と呼んでいます。

Trinityでは設計書毎に様々な原紙を標準で用意しています。例えばプリントレイアウトなら132桁用と198桁用の2種類を用意していますので、レイアウトサイズにあわせて選択することができます。またプログラム関連図などの印刷枚数が膨大になってしまうものについては、原紙を変更することで印刷枚数を抑えることもできます。

特徴
設計書様式のカスタマイズ
原紙(設計書様式)は導入時点で既に数多くのものが用意されていますが、これらを開発現場の要望にあわせてカスタマイズすることができます。

例えば原紙に自社名を出力した場合、文字として出力することもできますし、社名ロゴをイメージとして出力することもできます。またA4横の用紙サイズをA4縦に統一したり、原紙の見出しをまったく異なる形式に変更することもできます。

もちろん新しい原紙を作り出すことも可能です。Trinityの原紙は「書式」と呼ばれる単機能の印刷パーツの組み合わせとして定義されています。「書式」は現在、以下の8種類が用意されています。

書式の種類 内容
階層構成図 セグメント構成図など、階層関係を図で出力
入出力関連図 プログラム仕様書など、ファイルの入出力を図で出力
画面/帳票レイアウト 画面やプリントのレイアウトを出力
一覧表 一般的な一覧表を出力
ファイルレイアウト ファイルレイアウトを出力
処理フロー 処理フローなど、処理の流れを図で出力
ヘッダー/フッター 設計書のヘッダー/フッターを出力
フリーフォーマット より自由度の高いヘッダー/フッター

これらを組み合わせることで独自の設計書を作成することができます。もちろん各書式には様々な設定が存在しますので、要望にあった細かな調整を行うことができるようになっています。

※原紙および書式の変更についてマニュアルを提供しておりません。
※原紙のカスタマイズをご希望の場合には弊社にて請け負います。

特徴
管理資料 - 資産の目録
辞書を有効活用した設計資料に「管理資料」があります。管理資料は自動作成したソフトウェア資産の目録のようなものです。

この中でも特に辞書の恩恵を受けているのが「NET」と呼ばれる一連の資料です。

例えば、あるプログラムを変更した場合の影響範囲を調べるために上層プログラムを知りたい場合、プログラム一覧のNET版である「プログラムNET一覧」を閲覧することで、自身を呼び出す上層プログラムの一覧を簡単に調べることができます。NET系の資料には他にもCL、各種DDS版が用意されていますので、特定のメンバーを参照している上層プログラムを簡単に見つけ出すことができます。

他にも「ファイル一覧」ではレコードの長さを、「プログラムSTEP一覧」ではソースのコメント行数や処理行数を閲覧することができます。 これらも全て辞書に保管された情報を元に出力が行われています。このように辞書を活用することで、より情報量の豊かな設計書の作成が行われています。