SAMPLE 01 — 解読レポート
解読レポート(マクロの仕様書化・引き継ぎ)
「作った人が退職して、誰も中身が分からない」マクロを読み解き、 何を・どの順で・どのシートにしているかを日本語に起こした文書です。 ボタンと処理の対応表、処理の流れ、変えてよい設定・触ってはいけない箇所、気づいたリスクまでを1枚にまとめます。
解読レポートの見本を見るExcel VBA — Documentation Samples
Excelマクロ(VBA)の修正や解読をお引き受けするとき、修正済みのブックだけでなく、 「何を・なぜ・どう変えたか」「このマクロは何をしているのか」を日本語で残した文書を必ずお付けしています。 次に同じトラブルが起きたときや、別の方が引き継ぐときに、そのまま手がかりになるからです。 ここでは、その納品文書の実物見本を5点公開しています。
※ 見本の題材は、この見本のために自作した架空の「請求書作成マクロ」です。 実際のお客様のファイル・データ・社名は一切使用していません。
SAMPLE 01 — 解読レポート
「作った人が退職して、誰も中身が分からない」マクロを読み解き、 何を・どの順で・どのシートにしているかを日本語に起こした文書です。 ボタンと処理の対応表、処理の流れ、変えてよい設定・触ってはいけない箇所、気づいたリスクまでを1枚にまとめます。
解読レポートの見本を見るSAMPLE 02 — 変更内容書
エラー修正のご依頼で、修正済みブックに添えてお渡しする文書です。 原因を非エンジニアの方にも分かる言葉で説明し、どこを・どう変えたか、 影響範囲はどこまでか、今回変えていないことは何か、を明記します。
変更内容書の見本を見るSAMPLE 03 — 動作確認書
修正後のブックを納品する前に、何を・どんな手順で・どうなることを確認したかを表で残す文書です。 正常系だけでなく「今回の事象が再発しないこと」「空欄などの異常系」も項目に含め、 お客様側で行っていただく最終確認の手順まで書き添えます。
動作確認書の見本を見るSAMPLE 04 — 引き継ぎ手順書
ボタンと処理の対応・処理の流れ・変えてよい設定と触ってはいけない箇所に加えて、 「よくあるトラブルと対処」の表まで含めた運用向けの文書です。 コードを読まなくても、この1枚で次の担当の方が業務を続けられることを目指しています。
引き継ぎ手順書の見本を見るSAMPLE 05 — ソースの保管方法
マクロはブックの中に入っているため、ブックが壊れるとコードごと失われます。 納品するソースコード一式を「保険」として活かすための保管のしかた(日付フォルダ方式/Git方式)と、 今後の取り出し方を非エンジニアの方向けに1枚で案内する文書です。
ソースの保管方法の見本を見る修正のご依頼では、上の文書を含む次のセットをzipでお渡しします(内容はご依頼の規模により変わります)。
| 修正済みブック | 動作確認済みの本体。お送りいただいた元ファイルはそのまま保全します(何をどう確認したかは → 動作確認書の見本)。 |
|---|---|
| ソースコード一式(修正前・修正後) | マクロの中身をテキストファイルで取り出したもの。ブックが万一壊れてもコードが残る「保険」です(保管のしかた → ソースの保管方法の見本)。 |
| 変更内容書 | どこを・なぜ・どう変えたか(→ 見本)。 |
| 動作確認書 | 何をどう確認したか。お客様側で行っていただく最終確認の手順つき(→ 見本)。 |
| 引き継ぎ手順書 | 処理の流れ・設定値・触ってはいけない箇所・よくあるトラブルと対処(→ 見本)。 |