開発ドキュメントの入力支援に利用する

開発ドキュメントの入力支援に利用する

開発ドキュメントの入力支援とは、定義書に項目名（日本語）だけを記入しておき、後は入力支援ツールに任せるというものです。これにより人手入力項目の削減が行えるため、作業の効率化がはかれます。

リポジトリで何の項目を管理するかにより、定義書内の自動入力箇所が変わってきます。定義書ヘッダー部に記入するシステムIDやシステム名、画面IDや画面名なども項目としてリポジトリで管理しておけば、マクロで対応可能です。

またリポジトリに対応する項目がない場合は「？？？？？」などを表示するようにします。こうすることで、入力項目が間違っているのか、新しくリポジトリに登録する項目なのかを判断できるようにしておくとよいでしょう。

ドキュメントの数が数百、それにともない項目の数が数千となると、ドキュメントの記入作業は膨大になり、一字一句間違えなく入力することが難しくなります。しかし、リポジトリに登録しておけば、マクロを使用して大幅な工数軽減が実現できるでしょう。

開発ドキュメントの項目チェックに利用する

開発ドキュメントの項目チェックとは、リポジトリにある項目とシートの相違をチェックするものです。これは主にユーザ側の納品時のチェックに使われます。

開発時当初は入力支援ツールを使用していても、1箇所の修正だからといってツールを使用しなかったり、リポジトリ内項目名の修正を行って定義書はそのままになっていたりするケースが大いに考えられます。

ドキュメントの品質管理という点からも最終的に納品時ユーザ側が項目チェックツールを使用して、すべての項目がリポジトリと相違がないかを調べる必要があるでしょう。

項目チェックは、メニューシートのボタン起動で順次チェックできるようにしておきます。エラーがあった場合はエラーログシートにドキュメン ト名、パス、エラーセル位置を出力するようにします。また、そのパスからドキュメントを開き、エラーセルが選択されるようにしておけば、修正もすぐに行え るので便利です。

これらの項目精査をもし人手で行った場合どうでしょう？

作業的には非常に難しいでしょう。ロジカルな部分のチェックはマクロではできませんが、項目精査の作業をマクロで行う意味は非常に大きいと思います。