Excel VBA — Documentation Samples

マクロの修正・解読を、
「直して終わり」にしない納品文書。

Excelマクロ(VBA)の修正や解読をお引き受けするとき、修正済みのブックだけでなく、 「何を・なぜ・どう変えたか」「このマクロは何をしているのか」を日本語で残した文書を必ずお付けしています。 次に同じトラブルが起きたときや、別の方が引き継ぐときに、そのまま手がかりになるからです。 ここでは、その納品文書の実物見本を5点公開しています。

※ 見本の題材は、この見本のために自作した架空の「請求書作成マクロ」です。 実際のお客様のファイル・データ・社名は一切使用していません。

SAMPLE 01 — 解読レポート

解読レポート(マクロの仕様書化・引き継ぎ)

「作った人が退職して、誰も中身が分からない」マクロを読み解き、 何を・どの順で・どのシートにしているかを日本語に起こした文書です。 ボタンと処理の対応表、処理の流れ、変えてよい設定・触ってはいけない箇所、気づいたリスクまでを1枚にまとめます。

想定場面:引き継ぎ・属人化の解消/ブックは変更せず読み取りのみで作成

解読レポートの見本を見る

SAMPLE 02 — 変更内容書

変更内容書(マクロ修正の報告書)

エラー修正のご依頼で、修正済みブックに添えてお渡しする文書です。 原因を非エンジニアの方にも分かる言葉で説明し、どこを・どう変えたか、 影響範囲はどこまでか、今回変えていないことは何か、を明記します。

想定場面:「マクロが動かなくなった」の修正納品時/A4 1枚

変更内容書の見本を見る

SAMPLE 03 — 動作確認書

動作確認書(何をどう確認したかの記録)

修正後のブックを納品する前に、何を・どんな手順で・どうなることを確認したかを表で残す文書です。 正常系だけでなく「今回の事象が再発しないこと」「空欄などの異常系」も項目に含め、 お客様側で行っていただく最終確認の手順まで書き添えます。

想定場面:修正の納品時(スタンダード以上)/結果は確認実施後にのみ記入

動作確認書の見本を見る

SAMPLE 04 — 引き継ぎ手順書

引き継ぎ手順書(担当が代わっても運用できるように)

ボタンと処理の対応・処理の流れ・変えてよい設定と触ってはいけない箇所に加えて、 「よくあるトラブルと対処」の表まで含めた運用向けの文書です。 コードを読まなくても、この1枚で次の担当の方が業務を続けられることを目指しています。

想定場面:担当交代・属人化の解消/プランに応じて同梱

引き継ぎ手順書の見本を見る

SAMPLE 05 — ソースの保管方法

ソースの保管方法(マクロの「保険」のかけ方)

マクロはブックの中に入っているため、ブックが壊れるとコードごと失われます。 納品するソースコード一式を「保険」として活かすための保管のしかた(日付フォルダ方式/Git方式)と、 今後の取り出し方を非エンジニアの方向けに1枚で案内する文書です。

想定場面:すべての納品に同梱する顧客向けのご案内

ソースの保管方法の見本を見る

納品パッケージの全体像

修正のご依頼では、上の文書を含む次のセットをzipでお渡しします(内容はご依頼の規模により変わります)。

納品物の一覧
修正済みブック 動作確認済みの本体。お送りいただいた元ファイルはそのまま保全します(何をどう確認したかは → 動作確認書の見本)。
ソースコード一式(修正前・修正後) マクロの中身をテキストファイルで取り出したもの。ブックが万一壊れてもコードが残る「保険」です(保管のしかた → ソースの保管方法の見本)。
変更内容書 どこを・なぜ・どう変えたか(→ 見本)。
動作確認書 何をどう確認したか。お客様側で行っていただく最終確認の手順つき(→ 見本)。
引き継ぎ手順書 処理の流れ・設定値・触ってはいけない箇所・よくあるトラブルと対処(→ 見本)。