← VS.
Engineering DocumentationReference
6 phases · 38+ doc types
Technical Documentation · Reference

Write the right thing
at the right time.

Documentation is a force multiplier for AI-led teams — it externalises context that models can consume, reduces onboarding friction, and makes decisions auditable when prompt strategies evolve.

Diataxis Framework6 Lifecycle Phases38+ Document Types
6
Project Phases
Discovery to maintenance
38+
Document Types
Across the full SDLC
4
Diataxis Modes
Tutorial, How-To, Reference, Explanation
1
Unified Framework
Applied consistently
Framework

The Diataxis Framework

Tutorial
Learning-oriented

Teaches through doing. Leads the reader step by step. The measure of success is the reader achieving something tangible.

e.g. A 'Getting started' guide that walks you through deploying your first service.
A tutorial that explains too much theory before letting the reader do anything.
How-To Guide
Task-oriented

Guides through a specific task. Assumes the reader knows what they want — they need the steps. Success = task completed.

e.g. How to rotate API keys without downtime.
A how-to that stops to explain why the technology works the way it does.
Reference
Information-oriented

Describes the system accurately. Written for readers who know what they're looking for. Consulted, not read from start to finish.

e.g. An API endpoint reference listing all parameters, types, and error codes.
Reference docs that include tutorials or opinions — mix contamination is the most common Diataxis mistake.
Explanation
Understanding-oriented

Builds understanding of why. Discusses concepts, context, history, and alternatives. Does not instruct.

e.g. An ADR explaining why the team chose event sourcing over a traditional CRUD model.
Explanation docs that drift into instructions — they should answer 'why' not 'how'.
DEPENDENCY GRAPH

Dependency Graph · Document Relationships

How documents depend on each other.

Hover any node to trace its prerequisite chain. Click to open the full document detail.

PHASE:
LegendPrerequisiteRelatedtutorialhowtoreferenceexplanation
P1DISCOVERY & IDEATIONP2ARCHITECTURE & DESIGNP3PLANNINGP4DEVELOPMENTP5REVIEW & LAUNCHP6HANDOVER & MAINTENANCEOpportunity BriefResearch NotesAssumption LogCompetitive Anal…Stakeholder MapValue PropositionADRTech Design DocSystem DesignAPI ContractData ModelSequence DiagramsIaC DocsSLO DefinitionPRDFSDNFR DocWBSRisk RegisterDefinition of Do…Dependency MapCapacity PlanCommunication Pl…READMEInline DocsChangelogDev Setup GuideTest PlanPR TemplateCoding StandardsMigration GuideFeature Flag DocsRelease NotesRunbookIncident PlaybookSecurity ReviewLoad Test ReportA11y AuditLaunch ChecklistHelp Center DocsHandover DocPost-MortemKnowledge BaseDeprecation Noti…DR PlanOn-Call GuideTech Debt Regist…Arch Fitness
72Prerequisite edges
100Related links
48Document nodes
1.5Avg. prereqs per doc
DIATAXIS:tutorialhowtoreferenceexplanation

Framework Matrix

Diataxis × Project Lifecycle

Every document type mapped to its phase and documentation mode simultaneously.

Tutorial

Learning-oriented

How-To Guide

Task-oriented

Reference

Information-oriented

Explanation

Understanding-oriented

01Discovery & IdeationCapture the problem before building the solution
02Architecture & DesignRecord the decisions that shape everything downstream
03PlanningAgree on scope, requirements, and risk before a line of code
04DevelopmentKeep the team aligned while the system is being built
05Review & LaunchPrepare operators and users for what you're shipping
06Handover & MaintenancePreserve knowledge beyond the original team

↑ Click any document chip to view full details

MATURITY

Documentation Maturity · Self-Assessment

Where does your team stand?

Five levels from chaotic to continuous. Understand your current state before planning the next step.

1
Ad Hoc
2
Reactive
3
Standardised
4
Measured
5
Continuous
Level 1Ad Hoc

Characteristics

  • Documentation lives in Slack threads, personal notes, and people's heads
  • No templates, no ownership, no consistent format across projects
  • Knowledge is retrieved by asking the right person, not reading the right document

You are here if…

  • New team members require a week of hand-holding to get oriented
  • The same question is answered in Slack three times this month

To reach Level 2

  • 1.Adopt a minimal template for at least one document type (e.g., README + ADR)
  • 2.Assign a named owner to every existing document this quarter

Typical org pattern

Startup / solo team / early-stage project with no dedicated technical writer

Pre-Sales Track · 9 Phases

Before there's a project, there's a bid.

Everything above this line assumes a contract already exists. It doesn't — not yet. The RFP & Bid Lifecycle is a separate track with its own owners (capture and bid management, not delivery), its own gate reviews (bid/no-bid and deal desk, not design review), and a hard external deadline the customer sets. It runs from qualifying the opportunity through award, debrief, and a structured handover — which is exactly where it connects into SDLC Phase 01: Discovery & Ideation below.

9
Bid Phases
Qualification to transition
35+
Bid Document Types
Across the pre-sales lifecycle
6
Color-Team Reviews
Blue, Pink, Red, Green, Gold, White
1
Bridge into Delivery
Feeds directly into SDLC Phase 01

The Nine Phases

01
Phase 01

Opportunity Qualification & Capture Planning

Decide whether to bid, and start winning before writing anything

02
Phase 02

RFP Analysis & Clarification

Shred the RFP into requirements and use the Q&A window before it closes

03
Phase 03

Solution Development

Design the offering: technical solution, delivery model, staffing, win themes

04
Phase 04

Cost Estimation & Pricing

Build the cost bottom-up, set the price top-down, and know the difference

05
Phase 05

Proposal Development

Write for the evaluator: compliant, scorable, and easy to mark

06
Phase 06

Deal Review & Approval

Internal governance decides whether the company stands behind this offer

07
Phase 07

Production & Submission

Compliance is binary — perfect and on time, or rejected

08
Phase 08

Orals, Clarifications & Negotiation

The bid isn't over at submission — now you defend it in person

09
Phase 09

Award, Debrief & Transition

Win or lose, extract the value: lessons, content, and a clean handover

Color-Team Review Glossary

Blue TeamPhase 1 → 3

Reviews capture strategy and win themes before solutioning begins.

Pink TeamPhase 3 → 5

Reviews storyboards and the annotated outline before full writing starts.

Red TeamPhase 5 → 6

Scores the complete draft exactly as the customer's evaluators would.

Green TeamPhase 4 / 6

Reviews cost, price, and commercial risk before it's locked in.

Gold TeamPhase 6 → 7

Final executive review of the submission-ready package.

White TeamPhase 9

Post-submission lessons-learned review, win or lose.

Jump to Phase
Opportunity Qualification & Capture Planning
01
Phase 01

Opportunity Qualification & Capture Planning

Decide whether to bid, and start winning before writing anything

Document TypeOwnerAudienceDiataxis
Bid/No-Bid Decision MatrixSales Lead / Capture ManagerExecutive sponsor, Sales leadership
Reference
+
Capture PlanCapture ManagerBid team, Sales leadership
Explanation
+
Customer & Competitive Intelligence BriefSales / Capture ManagerSolution and proposal team
Reference
+
Teaming & Partner AgreementsCapture Manager / LegalExecutives, Legal, Partner organizations
Reference
+
02
Phase 02

RFP Analysis & Clarification

Shred the RFP into requirements and use the Q&A window before it closes

Document TypeOwnerAudienceDiataxis
Compliance MatrixProposal ManagerEntire bid team
Reference
+
Clarification Question Log (Q&A Log)Bid ManagerBid team, Customer (submitted subset)
Reference
+
Amendment & Addendum TrackerBid ManagerEntire bid team
Reference
+
Evaluation Criteria AnalysisCapture Manager / Proposal ManagerSolution and writing teams
Explanation
+
03
Phase 03

Solution Development

Design the offering: technical solution, delivery model, staffing, win themes

Document TypeOwnerAudienceDiataxis
Win Strategy & Win ThemesCapture ManagerAll proposal authors
Explanation
+
Solution Architecture Overview (Bid-Level)Solution ArchitectProposal team, Pricing, Customer evaluators
Explanation
+
Delivery & Staffing PlanDelivery Lead / PMOPricing, Proposal team, Customer evaluators
Reference
+
Bid Assumptions & Dependencies RegisterSolution Architect / Bid ManagerPricing, Legal, Deal review
Reference
+
Delivery Risk AssessmentDelivery LeadDeal review, Pricing, Proposal team
Reference
+
04
Phase 04

Cost Estimation & Pricing

Build the cost bottom-up, set the price top-down, and know the difference

Document TypeOwnerAudienceDiataxis
Basis of Estimate (BOE)Delivery Lead / Estimating LeadPricing, Deal review, future Delivery team
Explanation
+
Cost Model / Pricing WorkbookCommercial / Finance LeadDeal review, Executives
Reference
+
Price-to-Win AnalysisCapture Manager / Commercial LeadExecutives, Deal review
Explanation
+
Commercial Terms SheetCommercial Lead / LegalDeal review, Contracts, Customer (via proposal)
Reference
+
05
Phase 05

Proposal Development

Write for the evaluator: compliant, scorable, and easy to mark

Document TypeOwnerAudienceDiataxis
Proposal Outline & StoryboardsProposal ManagerAll authors, Pink Team reviewers
Reference
+
Executive SummaryCapture Manager (written), Executive sponsor (signed)Customer decision-makers
Explanation
+
Technical Volume / Technical ResponseSolution ArchitectCustomer technical evaluators
Explanation
+
Management VolumeDelivery Lead / PMOCustomer evaluators
Explanation
+
Past Performance & Case StudiesProposal Manager / SalesCustomer evaluators
Reference
+
Red Team Review ReportRed Team Lead (independent reviewers)Proposal Manager, all authors
Reference
+
06
Phase 06

Deal Review & Approval

Internal governance decides whether the company stands behind this offer

Document TypeOwnerAudienceDiataxis
Deal Review PackBid Manager / Commercial LeadDeal desk, Executives
Reference
+
Legal & Contract Risk ReviewLegal CounselDeal desk, Executives, Bid Manager
Reference
+
Final Pricing Approval (Green Team Sign-off)Commercial / Finance LeadExecutives, Deal desk
Reference
+
07
Phase 07

Production & Submission

Compliance is binary — perfect and on time, or rejected

Document TypeOwnerAudienceDiataxis
Final Compliance & Submission ChecklistProposal ManagerBid Manager, Gold Team
Reference
+
Submission Package Manifest & ReceiptBid ManagerBid team, Legal (audit trail)
Reference
+
08
Phase 08

Orals, Clarifications & Negotiation

The bid isn't over at submission — now you defend it in person

Document TypeOwnerAudienceDiataxis
Orals Presentation & Demo ScriptCapture Manager / Engagement LeadCustomer evaluation panel
Explanation
+
Clarification & Question Response LogBid ManagerBid team, Legal
Reference
+
BAFO Response & Negotiation Position PaperCommercial Lead / Capture ManagerExecutives, Negotiation team
Explanation
+
09
Phase 09

Award, Debrief & Transition

Win or lose, extract the value: lessons, content, and a clean handover

Document TypeOwnerAudienceDiataxis
Win/Loss Review (Debrief Report)Capture Manager (facilitated independently)Sales leadership, future bid teams
Explanation
+
Contract Summary & Obligations RegisterContracts Manager / LegalDelivery team, Finance, PMO
Reference
+
Sales-to-Delivery Handover PackBid Manager + Delivery Lead (joint)Delivery team
Reference
+
Content Library UpdateProposal ManagerFuture bid teams
Reference
+

Cross-Phase Principles

What makes a winning proposal.

Compliant is the entry ticket. These eight principles cut across all nine phases and are the difference between a proposal that scores and one that wins.

01

Qualify hard, then commit fully

The cheapest bid to lose is the one you never start. But once past bid/no-bid, resource it to win — half-hearted bids cost almost as much as serious ones and win nothing.

02

Compliance is the entry ticket, not the win

A non-compliant proposal is rejected unread; a merely compliant one loses to a responsive one. Compliance matrix first, win themes second — but always both.

03

Write for the evaluator's job

Evaluators score dozens of documents against a rubric under time pressure. Mirror the RFP structure, answer first and elaborate second, make every scoring criterion findable in seconds.

04

Themes need proof

Every claim — "proven", "experienced", "innovative" — that isn't attached to a metric, a named project, or a verifiable artifact is filler that dilutes the claims that do have proof.

05

Price is designed, not discovered

Bottom-up cost and top-down price-to-win are built independently. The gap between them is closed by explicit decisions — descope, redesign, margin — never by quietly shrinking estimates.

06

Reviews only work when they can hurt

Pink, Red, and Gold teams need independent reviewers, the customer's real criteria, and enough calendar left to act on findings. A review that can't change the outcome is a ceremony.

07

Everything you say becomes the contract

Proposal text, clarification answers, orals claims, negotiation concessions — assume all of it is binding, and review it at that standard.

08

The bid isn't done until delivery accepts it

A win handed over as a document dump becomes delivery's problem and next year's reference-client risk. The handover pack is part of the bid, not an afterthought.

Where the bid becomes the project

Bid Phase 09

Award, Debrief & Transition

SDLC Phase 01

Discovery & Ideation

The Sales-to-Delivery Handover Pack carries the solution, assumptions, risk register, and budget straight into the Opportunity Brief — the bid team's knowledge becomes the delivery team's starting point.

Jump to Phase
Discovery & Ideation
01
Phase 01

Discovery & Ideation

Capture the problem before building the solution

Document TypeOwnerAudienceDiataxis
Opportunity Brief / Problem StatementProduct ManagerLeadership, Engineering
Explanation
+
User Research NotesUX ResearcherPM, Design, Engineering
Reference
+
Assumption LogTech LeadFull team
Reference
+
Competitive AnalysisProduct ManagerLeadership, Product, Design
Reference
+
Stakeholder MapProduct ManagerPM, Tech Lead, Leadership
Reference
+
Value Proposition CanvasProduct ManagerProduct, Design, Engineering
Explanation
+
02
Phase 02

Architecture & Design

Record the decisions that shape everything downstream

Document TypeOwnerAudienceDiataxis
Architecture Decision Record (ADR)Tech Lead / ArchitectEngineering team
Reference
+
Technical Design Document (TDD/TDR)ArchitectEngineering
Explanation
+
System Design Document (SDD)ArchitectEngineering, Ops
Reference
+
API Contract / Interface SpecificationLead EngineerFrontend, Backend, QA
Reference
+
Data Model / ERDData ArchitectEngineering, DBA
Reference
+
Sequence Diagrams / Interaction SpecsTech LeadEngineering, QA
Reference
+
Infrastructure-as-Code DocumentationDevOps EngineerEngineering, Ops, Security
Reference
+
Service Level Objectives (SLO) DefinitionSRE / ArchitectEngineering, PM, Leadership
Reference
+
03
Phase 03

Planning

Agree on scope, requirements, and risk before a line of code

Document TypeOwnerAudienceDiataxis
Product Requirements Document (PRD)Product ManagerEngineering, Design, QA
Explanation
+
Functional Specification Document (FSD)BA / PMEngineering, QA
Reference
+
Non-Functional Requirements (NFR) DocArchitectEngineering, Ops, Security
Reference
+
Work Breakdown Structure (WBS)Project ManagerFull team
Reference
+
Risk RegisterProject ManagerLeadership, PM
Reference
+
Definition of Done (DoD)Tech LeadEngineering, QA, PM
Reference
+
Dependency MapTech LeadEngineering, PM
Reference
+
Capacity Planning DocumentEngineering ManagerEngineering, Finance, Ops
Reference
+
Communication PlanProject ManagerAll stakeholders
How-To Guide
+
04
Phase 04

Development

Keep the team aligned while the system is being built

Document TypeOwnerAudienceDiataxis
READMELead EngineerDevelopers
How-To Guide
+
Code Comments / Inline DocsDeveloperDevelopers
Reference
+
Changelog / CHANGELOG.mdLead EngineerAll stakeholders
Reference
+
Developer Setup GuideLead EngineerDevelopers
How-To Guide
+
Testing Strategy / Test PlanQA LeadQA, Engineering
How-To Guide
+
Pull Request Template / Description StandardsTech LeadEngineering
Reference
+
Coding Standards & Style GuideTech LeadEngineering
Reference
+
Migration GuideLead EngineerDevelopers, Ops
How-To Guide
+
Feature Flag DocumentationLead EngineerEngineering, PM, QA
Reference
+
05
Phase 05

Review & Launch

Prepare operators and users for what you're shipping

Document TypeOwnerAudienceDiataxis
Release NotesPM / Tech LeadAll stakeholders
Reference
+
Runbook / Operations ManualDevOps / SREOps, On-call
How-To Guide
+
Incident Response PlaybookSRE / Tech LeadOn-call, Engineering
How-To Guide
+
Security Review DocumentSecurity EngineerArchitect, PM, Legal
Reference
+
Load Test ReportQA / SREEngineering, PM, Ops
Reference
+
Accessibility AuditUX Engineer / QAEngineering, Design, Legal
Reference
+
Launch ChecklistPM / Tech LeadFull team
How-To Guide
+
User-Facing Documentation (Help Center)Technical Writer / PMEnd Users
Tutorial
+
06
Phase 06

Handover & Maintenance

Preserve knowledge beyond the original team

Document TypeOwnerAudienceDiataxis
Handover DocumentTech LeadIncoming team
How-To Guide
+
Post-Mortem / Retrospective ReportTech Lead / PMFull team, Leadership
Explanation
+
Knowledge Base ArticlesAny contributorAll users / future devs
Tutorial
+
Deprecation NoticeProduct ManagerUsers, Developers
Reference
+
Disaster Recovery PlanSRE / ArchitectOps, Engineering, Leadership
How-To Guide
+
On-Call Rotation & Escalation GuideEngineering ManagerEngineering, SRE
How-To Guide
+
Technical Debt RegisterTech LeadEngineering, PM
Reference
+
Architecture Fitness FunctionsArchitectEngineering, Tech Lead
Reference
+

Communication Matrix

Stakeholder Responsibility Matrix

Who owns, contributes to, and stays informed on each document type.

DocumentEngineeringPMDesignQAOps/SRELeadershipLegal/ComplianceEnd Users
Phase 1Discovery & Ideation
Opportunity Brief
User Research Notes
Competitive Analysis
Stakeholder Map
Value Proposition
Phase 2Architecture & Design
ADR
Tech Design Doc
System Design
API Contract
SLO Definition
Phase 3Planning
PRD
FSD
Risk Register
Definition of Done
Phase 4Development
README
Changelog
Test Plan
Coding Standards
Phase 5Review & Launch
Release Notes
Runbook
Incident Playbook
Security Review
Launch Checklist
Phase 6Handover & Maintenance
Post-Mortem
Handover Doc
DR Plan
Tech Debt Register
Legend:PrimarySecondaryInformed

Best Practices · 12 Do / Don't Pairs

Write with intention.

Opinionated rules for documentation that actually gets read, used, and maintained.

01Writing for the reader
Do ✓

Write for the engineer 6 months from now who has no context. Assume zero shared memory.

Don't ✗

Write for yourself today — you already know everything and it shows.

02Structuring for scannability
Do ✓

Use headers every 3–5 paragraphs; lead with the most important info. Readers scan before they read.

Don't ✗

Write walls of prose — dense paragraphs signal effort but destroy comprehension.

03Atomic docs vs. monolithic
Do ✓

One topic per document; link rather than duplicate. Atomic docs are easier to update, find, and own.

Don't ✗

Combine the PRD, FSD, and TDD into one mega-doc. It becomes unmaintainable and unreadable.

04Active voice
Do ✓

Write 'The system sends a request' — active voice is faster to read and clarifies responsibility.

Don't ✗

Use passive voice — 'a request is sent by the system' hides who does what.

05Concrete examples
Do ✓

Include a working code snippet or real URL in every technical doc. Examples are worth a thousand words.

Don't ✗

Use abstract descriptions when an example would be clearer — abstraction is a crutch, not a virtue.

06Versioning docs
Do ✓

Add a 'last-reviewed' date and increment the version when content changes. Stale docs are dangerous docs.

Don't ✗

Treat docs as immutable after publishing — they rot silently and mislead people at the worst moments.

07Curse of knowledge
Do ✓

Define acronyms on first use; link to background concepts; assume the minimum shared context.

Don't ✗

Assume the reader shares your context — they're probably a different person in a different quarter.

08When NOT to document
Do ✓

Skip documentation for ephemeral decisions and self-explanatory code. Signal is scarce.

Don't ✗

Document everything — noise obscures the signal and good docs get lost in the flood of bad ones.

09Linking over duplicating
Do ✓

Link to the canonical source; add a one-line summary if needed for context. One source of truth.

Don't ✗

Copy content into multiple places — they diverge immediately and you spend the rest of eternity reconciling them.

10Good titles
Do ✓

Use the title to answer 'what will I learn / do?' — e.g. 'How to deploy to staging in 5 minutes'.

Don't ✗

Use vague titles like 'Notes' or 'Misc' — they're undiscoverable and signal a doc nobody owns.

11Diagrams vs. prose
Do ✓

Use diagrams for structure, flows, and relationships; use prose for reasoning, context, and nuance.

Don't ✗

Replace all diagrams with prose or all prose with diagrams — each format has a job.

12Writing good summaries
Do ✓

Start every doc with a one-paragraph TL;DR that lets the reader decide if they need to read on.

Don't ✗

Bury the key insight on page 3 — readers who don't find value in the first 10 seconds will not read page 3.

Docs as Code · Principles

Documentation is an engineering artefact.

Apply the same rigour to documentation that you apply to code. Version it, lint it, test it, and generate it where possible.

Version Control

Store docs alongside code in Git. PRs, reviews, and blame work for docs too — the same discipline that keeps code honest keeps docs honest.

Vale + Git

Documentation Linting

Enforce style, tone, and structure automatically. Catch passive voice, unclear headings, and broken links before review reaches human eyes.

Vale, markdownlint

Freshness Automation

Add last-modified timestamps to frontmatter. CI alerts when a doc hasn't been reviewed in 90 days. Stale is a bug.

GitHub Actions

Generated Docs

API docs from OpenAPI specs, type docs from TypeScript, architecture maps from code analysis. Auto-generated docs can't go stale.

Redoc, TypeDoc

Documentation Testing

Link checking, example validation, and screenshot testing for UI docs. If you wouldn't ship untested code, don't ship untested docs.

htmlproofer, Playwright

Co-located vs. External

Docs in the repo stay in sync with code; external wikis drift. The tradeoff is discoverability vs. co-location — choose deliberately.

Docusaurus, Mintlify

Tradeoffs: Docs in Repo vs. External Wiki

CriterionDocs in RepoExternal Wiki
Sync with code
Discoverability for non-engineers
Granular access control
Non-technical contributor access
Versioning per release

Tool Ecosystem · Curated Reference

The right tool for the job.

A curated reference across writing, diagramming, API documentation, linting, and automation.

Writing

Notion

All-in-one workspace with rich blocks and database views.

Best forTeam wikis and lightweight docs
Pairs withKnowledge Base

GitBook

Git-backed docs with automatic versioning and branching.

Best forTechnical documentation sites
Pairs withAPI Contract

Docusaurus

React-based static site generator with versioning built in.

Best forOpen-source project documentation
Pairs withREADME

Mintlify

Beautiful API docs and developer portals with zero configuration.

Best forDeveloper portals
Pairs withAPI Contract
Diagramming

Mermaid

Diagrams as code embedded in Markdown — no design tool needed.

Best forSequence and flow diagrams in repos
Pairs withSequence Diagrams

Excalidraw

Whiteboard-style sketching with a hand-drawn aesthetic.

Best forQuick architecture sketches
Pairs withSystem Design

D2

Declarative diagramming language with layout auto-computation.

Best forInfrastructure and topology diagrams
Pairs withIaC Docs

PlantUML

Text-based UML generation from plain-text DSL.

Best forClass diagrams and ER models
Pairs withData Model
API Docs

OpenAPI / Swagger

Industry-standard specification for REST APIs with broad tooling support.

Best forAny REST API
Pairs withAPI Contract

Redoc

Beautiful, three-panel OpenAPI renderer with zero configuration.

Best forExternal API documentation
Pairs withAPI Contract

Stoplight

API design, mocking, and documentation platform for API-first teams.

Best forAPI design and docs platform
Pairs withAPI Contract
Linting

Vale

Prose linter with custom style rules, tone checks, and readability scores.

Best forEnforcing writing standards at scale
Pairs withCoding Standards

markdownlint

Markdown structure and style linter with extensive rule configuration.

Best forRepository-based documentation
Pairs withREADME

alex

Catches insensitive, inconsiderate writing in your documentation.

Best forUser-facing and public docs
Pairs withHelp Center Docs
Automation

GitHub Actions

CI/CD pipelines for docs: lint, link-check, freshness audit, and deploy.

Best forDocs-as-code pipelines
Pairs withCoding Standards

Dependabot

Automatically updates documentation tooling dependencies.

Best forVersion-pinned doc tooling
Pairs withMigration Guide

Netlify

Deploy previews for documentation sites on every pull request.

Best forReview-before-merge workflows
Pairs withPR Template
LIFECYCLE

Lifecycle Governance · States & Cadences

Documents have a lifecycle, not a shelf life.

Govern the full arc from first draft to archival. Freshness is a design requirement, not an afterthought.

DraftAuthor

Creates document from template; fills in context, decisions, and open questions.

In ReviewAuthor → Reviewers

Author requests review; reviewers comment on accuracy, completeness, and clarity.

PublishedReviewer / Approver

Reviewer approves; document is merged or published to canonical location.

StaleAutomated CI / Owner

90 days without update triggers automated alert; owner decides to update or archive.

ArchivedOwner

Owner marks as superseded or retired; document preserved as historical record.

Review Cadence Reference

Document TypeRecommended CadenceImmediate Review Trigger
ADRNever — supersede insteadWhen the decision is reversed or revisited
RunbookAfter every incidentAny production incident touching the system
Risk RegisterEvery major milestoneNew risk identified or risk materialises
SLO DefinitionQuarterlySLO breach or business model change
PRDWhen requirements changeStakeholder scope change or user research invalidates assumptions
API ContractBefore every breaking changeAny change to request/response schema or auth
Security ReviewEvery major releaseNew data type handled or threat landscape shift
Knowledge BaseEvery 6 monthsProduct feature change renders article inaccurate
Architecture FitnessContinuous / CIFitness function fails in pipeline
Handover Doc30 days before transitionTeam member departure confirmed
AI-Specific Considerations

Documentation patterns for AI-led engineering

ADRs in AI Systems

AI systems accumulate invisible decisions — which model version, which prompt strategy, which embedding dimensionality. ADRs make these auditable. When a model update breaks production behaviour, you need to know what was decided and why, not just what changed.

Runbooks for Model Drift

Model drift is not a bug — it is a property of production ML systems. Your runbook should include drift detection thresholds, retraining triggers, and rollback procedures. An on-call engineer should be able to execute the full response at 3am without Slack.

Handover at the Model Boundary

When AI capabilities are embedded in a product and the team that built them moves on, what gets lost is not the code — it is the intent. Which prompts are load-bearing? Which system messages cannot change without breaking downstream behaviour? Document it before you leave.