What it does

The Model Documentation Generator reads a workbook and produces a methodology note explaining how it works: what each tab does, what feeds what, and how the key calculations are built. It describes the model as it is, in plain English, so someone new can understand it without reverse-engineering formulas.

When to use it

  • Handing a model over to a colleague, client or reviewer.
  • Picking up a model you didn’t build.
  • When someone asks “how does this spreadsheet work?”

How it works

  1. Read the whole workbook, including hidden and very hidden sheets, which can hold critical logic.
  2. Map the architecture: the tab list with each tab’s purpose and the direction data flows.
  3. Explain the calculations section by section: inputs, method in plain English (“revenue multiplied by gross margin”, not =D15*$B$8), outputs, downstream dependencies and sensitivities.
  4. Trace the dependency chain to show what feeds what.
  5. Summarise assumptions, referring to the Skill 09 register where it exists, or listing the top 10 to 15 if it doesn’t.
  6. Record limitations: what isn’t modelled, known simplifications, data dependencies and fragile sections that are easy to break.
  7. Pull version history from the Change Log.

What you get

A methodology note, as text or as a Documentation tab, structured top-down: overview, architecture map, calculation mechanics, data flow, assumptions summary, limitations and caveats, and version history. Named ranges are grouped by prefix, the active scenario is noted, and any VBA macros in .xlsm files have their purpose documented.

Good to know

  • Describes what is. It doesn’t modify the model or recommend changes. Use Skill 21 for a scored best-practice review.
  • Assumption lists are not duplicated: if Skill 09 has run, the note refers to it.
  • Brittle sections are flagged so the next person knows where to take care.