liveBook · Manning

Documentation

As explained in Think Like a Software Engineering Manager

The practice of recording information about systems, processes, decisions, or procedures for later reference.

When a remote teammate needs to resolve a problem, the right information should not depend on finding the one person who knows the answer. Documentation is a written record people can return to: it helps them learn, understand agreements, and carry out work with less reliance on others. section 3.2.5 section 11.3.2

Match the record to the job:

  • For team decisions, share meeting outcomes or minutes. Keep agreements available for projects spanning multiple teams or long periods, and revisit expectations in check-ins. section 3.2.5 section 11.3.2
  • For a service, describe its features and show how components interact. Use a runbook for ownership, maintenance, and problem-resolution procedures; link relevant monitoring alerts to it when useful. section 12.2.5
  • For a departure or leadership change, document critical knowledge alongside conversations and handover plans. The aim is continuity, not replacing discussion with a document. section 8.4.3 section 13.3.1

Record an agreed plan

An engineering manager meets with the team and product leadership to align on a road map and project sizing. Detailed minutes, shared afterward by email, give both groups the same reference for their expectations. section 11.3.2

Start with the information someone would otherwise have to ask for. After recording it, share it with the people who need it—and keep checking that agreements and procedures still match the work. section 3.2.5 section 11.3.2 section 12.2.5

How Think Like a Software Engineering Manager covers it

How deep it goes
Distinguishes records for agreements, services, and procedures, with guidance on sharing and review rather than a detailed documentation-writing method.
Examples
Uses shared meeting minutes, troubleshooting runbooks, service diagrams, and departure handovers as concrete artifacts.
What you can do after
Practice/perform documentation by recording agreements and critical operational knowledge so teammates can consult them during work and transitions.
How it connects
Connects documentation to remote collaboration, expectation management, runbooks, monitoring, and knowledge transfer.

Also explained in

Compare how 12 books explain documentation →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Think Like a Software Engineering Manager. The section links point to the parts of the book it draws on.