第3回:リポジトリを使用したドキュメントの入力支援 (1/3)

ドキュメント作成の技

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

第3回:リポジトリを使用したドキュメントの入力支援

著者:株式会社ビズモ 榎 孝次

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

リポジトリの有用性

今回はリポジトリを使用した開発ドキュメントの入力支援&チェック機能について解説していきます。また、最後にサンプルのマクロがありますので、ぜひダウンロードして試してください。

リポジトリを使用してドキュメント内の項目を統一することで、以降のシステム開発でも項目の統一性を保つことが可能です。リポジトリとはデータを管理するRDBのことです。RDBには有償・無償データベースがあります。通常は接続にドライバ(ODBC)が必要となりますが、本記事では新しいドライバのインストールが必要ないMicrosoft製品「Access」を使用します。

Accessとの接続は、Microsoft ActiveX Data Objects x.x Library(ADO)をVisual Basic Editorの「ツールメニュー → 参照設定」から選択するだけで完了です。

今回リポジトリで管理する項目は、開発ドキュメントに関して入力支援&チェック機能となります(図1)。基本的にはテーブルで定義しているものを管理すると考えればよいでしょう。

Image

リポジトリの構築と管理

ではリポジトリを構築していきましょう。一番の早道は、今まで開発に利用したテーブル定義書を流用してリポジトリの構築をすることです。まずは管理項目を定義書から抽出してExcelシートを作成します。それをAccessのテーブルにコピー&ペーストします。これだけでリポジトリの構築が完了です。

また今後新しい項目が発生した場合に備えて、リポジトリに登録するマクロも作成しておくとよいでしょう。

リポジトリに登録する項目名は、今後のシステム開発にも使用していくものです。そのため項目名(英字)、項目名(日本語)を登録する際は、慎重に決定してください。

過去のテーブル定義書などから項目を集めてみると、同じ項目名(日本語)なのに英字が異なっていることや、同じ意味なのに日本語名が異なっていることなどが発見できると思います。今後はそのようなことがないように、リポジトリで項目名の一元管理をしていくことが重要です。

マクロを使うにあたって、Excelのツールバーをカスタマイズすることをお勧めします。今回は入力支援ボタンを追加しました。これによりマクロを起動するとツールバーにボタンが出現し、他のエクセルを開いてもマクロが実行できる仕組みにしてあります。

では、実際にリポジトリを使った開発ドキュメントの入力支援についてみていきましょう。 次のページ




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


INDEX
第3回:リポジトリを使用したドキュメントの入力支援
リポジトリの有用性
 開発ドキュメントの入力支援に利用する
 リポジトリの活用
【楽々デブドックを書こう!】ドキュメント作成の技
第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