【VBA関係】VBAアプリケーションのREADMEへの記載が推奨される6つの項目 ～網羅性と粒度のバランスを考慮～｜ポテの学習メモ #014
運営者・ポテアフィリエイト広告を利用しています。
VBAアプリケーションの最大の魅力は、何といっても圧倒的な「手軽さ」。他の言語にはない大きな利点と言える。
READMEや要件定義書もExcelファイル内にまとめておけば、一つのパッケージとして完結し、さらに利便性が高まる。
例）
今回は、その中の「README」に書く内容をまとめる。網羅性と粒度のバランスの良さを重視した。
READMEに記載する6つの項目 ～網羅性と粒度のバランスを考慮～
以下に、READMEに記載することが推奨される6つの項目についてまとめる。この6つを基本として、あとはそれぞれのアプリに応じて項目の増減などを調整する。
概要
次のような内容を1～3行程度で書く。
- アプリケーションの簡単な説明
- 何をするアプリケーションなのか
- どのような目的で作られたのか
例）
本アプリケーションは、ファイルAとファイルBのデータを突き合わせ、データを統合・整理するアプリケーションです。
主な機能
実装している主な機能を書く。
例）
- 重複データの検出
ファイルA内、ファイルB内の重複しているデータをあらかじめ検出します。 - データ突き合わせ処理
ファイルAとファイルBのデータを突き合わせ、マッチしたデータをファイルCに出力します。合わせて、マッチした件数をメッセージボックスで通知します。
必要な環境
アプリケーションが動作する環境条件を書く。
例）
- Wndows10/11
- Microsoft Excel 2016以降
- 参照ライブラリ：
- Microsoft Scripting Runtime
使い方
使い方を書く。分かりやすく、シンプルに。ごちゃごちゃ書いている説明は誰も見ない。「操作画面シート」などに説明がある場合は、「操作画面シート参照」だけでOK。
例）
- 「01_入力A」フォルダにファイルA（.xlsx）を入れてください。
- 「02_入力B」フォルダにファイルB（.xlsx）を入れてください。
- 次のボタンをクリックしてください。数秒でファイルCが生成されます。
シンプルに書けない場合、アプリケーションの完成度が低い可能性がある。分かりにくい使い方しか書けないなら、改善すべきは 説明 ではなく アプリケーション 本体。
制限事項
アプリケーションがサポートしてない動作や製薬を書く。サポートしていない項目をきちんと書くことが誠実さ。
例）
- Windowsのライブラリを使用しているため、Mac環境では動作しません。
- 複数ファイルの処理には対応していません。「01_入力A」フォルダ、「02_入力B」フォルダには、それぞれひとつのファイルを入れてください。
- ファイルパスは、半角英数字にしてください。日本語を含むファイルパスは読み込めません。
- ファイルにパスワードは設定しないでください。
注意事項
ユーザーが気をつけるべきことを書く。
例）
- 実行前に必ずデータのバックアップを取ってください。
- 処理中にExcelを手動で操作しないでください。エラーの原因になります。
- 入力ファイルの形式を変えないでください。データの形式が変わると正しく動作しません。
- 入力ファイルは、10行目から対象のデータが始まる必要があります。
- 開始行：8行目からデータが始まる必要がありあす。
重要な列：2列目は最終行の確認、4列目はデータマッチング対象列です。 - データ範囲: 4行目以降、1列目～20列目を使用します。
おわりに
今後、README以外についてもまとめていく。
この記事を書いた人
- ■人生を追求する凡人■日本一安全で、気の向くままに自分の時間を過ごせる、こだわりのキャンプ場を作るのが夢■光学・機械系エンジニア（歴20年、内マネジメント10年、特許数件権利化）/副業フリーランスエンジニア■読書・文学愛好■人生は時間そのもの。ひとりでも多くの人が「より良い人生にするために時間を使って欲しい」と願い、仕事のスキルの向上、余暇の充実、資産形成を研究。■VBAアプリ開発サービス提供中（業務委託 / VBA使用経験20年）■Python愛好（歴5年）■VBAエキスパート「Excel VBA スタンダード」（上級者向け資格）/ Python 3 エンジニア認定基礎（経済産業省「ITスキル標準（ITSS）」に掲載）
