IT‑IS‑Networking
Technology › Enterprise Architecture & Governance

Design Documentation

The discipline of writing a design down, revising it under review, and stating its own risk plainly — carried to revision 16, 26 and 35 on the largest programs.

Also known as Architecture Decision Records, Design Review

Left to right is time. Each row is one of the 18 disciplines this one worked alongside, ordered so kindred disciplines sit next to each other rather than alphabetically — a landscape only means anything if neighboring rows belong together. Height is the work running in that domain in that year, weighted by what failure would have cost — life-safety ×3, a statutory obligation ×2.2, the estate itself ×1.5, an evaluation ×1. Every project declares which of those it was, so each ridge traces to an entry you can open and disagree with. Only the work that used this technology is counted, so what shows here is the company it kept rather than the record around it. Height and color are on the record-wide scale rather than this page’s own, so a modest estate draws a modest landscape and any two of these pages can be read against each other.

Design documents in this record are not artifacts produced after the fact. They are the mechanism by which a design is reviewed, argued over and approved, and their revision numbers are the evidence.

The Duval County Courthouse network design ran to 262 pages at revision 16 by the time it was executed. The consolidated CAD/911 dispatch design carried through thirty-five revisions and a review with the Florida Department of Law Enforcement. The enterprise Palo Alto firewall architecture reached twenty-six revisions over its life. The Annex data center consolidation ran on three documents at revisions ten, twelve and ten, each with its own drawing set, test plan and back-out plan.

The overview of the data center consolidation stated plainly that redundancy would be reduced for a period, and what was being done about it. A design document that hides its own risk is worth less than no document.

Also searched as

  • TOGAF
  • architecture decision record
  • ADR
  • reference architecture
  • architecture repository
  • target state