ドキュメント作成の技 2

開発のための自動生成について

開発のための自動生成について

「機能定義書からDDLテキストファイル(xxx.sql)を出力する機能」がマクロで実現できます。各RDB(Oracle、DB2、MySQL、PostgreSQLなど)に準拠したDDLを吐き出せるように工夫がしておくと便利でしょう。

「定義書からhtmlファイルを(xxx.html)を出力する機能」も実現できます。ただし、あくまでも定義書に記述してある項目のhtmlなので、スタイルなどの考慮は別途必要です。

また、「SQL定義書からDMLテキストファイル(xxx.sql)を出力する機能」も作成可能です。

さらに「業務ロジック定義書から単項目チェックソース出力(for Java)する機能」や「テスト仕様書からテストケース出力(for Java)」などがあります。これらがすべてマクロで自動生成が可能です。

図2:テーブルの対応例
図2:テーブルの対応例

品質管理(整合性チェック)支援について

XX一覧に記述してある定義書がXX項目定義書(XXは画面、帳票、テーブルに対応)として存在しているかをチェックし、またXX項目定義書がXX一覧にすべて記述してあるかをチェックします(表2)。

この場合、テーブル一覧に記述されている「品種マスター」がテーブル定義書にないありません。そのためエラーとなります。これを利用して、品質管理の場合は開発側の納品時のチェックとして、またユーザの場合は納品物検収時のチェックとして役立てることがでしょう。

いかがでしたでしょうか? 今回紹介したマクロ機能は、これらからマクロを作成しようと考えている人でもできるレベルですので、ぜひチャレンジしてみてください一度作成してしまえば 今後の開発においても適用できます。最初のマクロ作成に多少の工数がかかりますが、それ以降の作業では効率化をはかれるのではないでしょうか

今回の最後に「マクロ作成の注意点」として、Excelのバージョンについて解説します。

バージョンUPと共にマクロ関数のパラメータが変更されています。上位互換は基本的になされていると思いますので、マクロの作成は使用者の バージョンを把握して、バージョンが一番下のExcelで作成することをお勧めします。また各種ライブラリファイルも使用していくことになりますが、その 時も使用バージョンには注意してください。

マクロをの勉強するには、参考書をやWebサイトが便利です。大体のことはQ&Aサイトで解決できると思います。過去ログを見ているだけでもかなり勉強になりますので、一度は訪れてみてください。

さて次回はマクロをリポジトリ(データベース)に接続して、リポジトリからデータを取得し、ドキュメント内にデータを埋め込む入力支援&品質管理のための機能について解説していきます。

この記事をシェアしてください

人気記事トップ10

人気記事ランキングをもっと見る