第2回:マクロを使用した開発ドキュメントの自動生成 (3/3)

ドキュメント作成の技

【楽々デブドックを書こう!】ドキュメント作成の技

第2回:マクロを使用した開発ドキュメントの自動生成

著者:ビズモ 榎 孝次

公開日:2008/02/12(火)

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

「機能定義書から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サイトで解決できると思います。過去ログを見ているだけでもかなり勉強になりますので、一度は訪れてみてください。

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




株式会社ビズモ 榎 孝次
著者プロフィール
株式会社ビズモ 榎 孝次
シニアマネージャー
1981年からシステム開発に携わりCOBOLからJavaまで多彩な設計&開発経験を経て、現在はマネージャーの立場として開発に従事しているかたわら、プロジェクト管理や開発効率化を考えエクセルで管理&処理できるものはマクロで解決するマクロ好き。また社内システムであるプロジェクト案件管理や売上管理等も構築。
http://bizmo.co.jp/


INDEX
第2回:マクロを使用した開発ドキュメントの自動生成
 Excelのマクロの準備
 メニューボタンによる管理
開発のための自動生成について
【楽々デブドックを書こう!】ドキュメント作成の技
第1回開発ドキュメントを何で作成するか?
第2回マクロを使用した開発ドキュメントの自動生成
第3回リポジトリを使用したドキュメントの入力支援
第4回Excelによるドキュメント作成に効くTIPS!
関連記事
即活用!業務システムの開発ドキュメント標準化

人気記事トップ10

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

企画広告も役立つ情報バッチリ! Sponsored

ClickHouse Cloudが実現した広告運用SaaS「ATOM」のデータ基盤革新、パフォーマンスを向上しながら、運用負荷とコストを削減 11月11日 6:20 AIで開発が加速する時代、品質保証はどう変わる? Tricentisが示すAIエージェント活用の実像 11月9日 6:45 悪用までの猶予が「1分」に迫るフロンティアAI時代に開発と本番を貫く脆弱性管理が必要 10月29日 8:30 欧州CRA対応とSBOM運用。AI生成コードのOSS混入問題の対策とは ――スニペット単位で検出する「FossID」「Insignary Clarity」によるSBOM運用 9月16日 6:40 PostgreSQLからTiDBへ、稼働中SaaSで進める段階的DB移行の実践と再設計への展望 9月7日 6:30 機能安全開発におけるGoogleTestの活用を支援!「Parasoft C/C++test CT」で実現する効率化&AI連携 4月14日 6:30 【CNDW2025】Grafanaが明かす「オブザーバビリティの哲学」ー最小限の労力で実用的なインサイトを得るには 1月23日 6:30 【CNDW2025】プロダクト急増に備える基盤刷新 ーウェルスナビがECSからEKSへの移行で得た知見とは 1月15日 6:30 【CNDW2025】250環境を5人で運用、構築時間は30分に ーKINTOテクノロジーズが語るインフラ基盤組織の作り方 2025年12月18日 6:30 新たな自動化で熱視線! AIエージェントの「推論能力」を支える2つのコンポーネントとは? 2025年11月28日 6:30