How deeply does The Art of Code cover living documentation?

Defines automated generation and maintenance, explains its value and risk, but stops short of prescribing an implementation workflow.

Living documentation

As explained in The Art of Code

Living documentation is documentation automatically generated or maintained through the development process so that it reflects the current state of a system.

Living documentation is generated or maintained through development so it reflects the system’s current state with minimal updating effort. It preserves useful reasoning alongside implementation. section 3.2.1

From development artifacts to durable context

OpenAPI specifications and Cucumber scenarios can generate documentation as part of development. A bug-fix analysis can also record the error, root cause, alternatives, and chosen design decision for future maintainers. section 3.2.1 section 3.2.1

Use living documentation deliberately:

Keep it accurate and current; outdated documentation can mislead developers and AI agents. section 3.2.1
Store valuable reports and reviews in the codebase when they explain constraints, boundaries, decisions, or deferred improvements. section 3.2.1

How The Art of Code covers it

liveBook manning.com

Read The Art of Code on liveBook Get the book at manning.com

Also explained in

liveBook manning.com

BDD in Action, Second EditionLiving documentation is documentation generated from executable specifications so that it reflects and verifies the implemented behavior of software features.
liveBook manning.com

Collaborative Software Design: How to facilitate domain modeling decisionsDocumentation that is continuously revised to reflect changes in the system, model, design, or decisions it describes.

Compare how 3 books explain living documentation →

Related concepts

documentationkind of · Documentation is recorded explanatory, instructional, or reference information that describes a subject, system, or process to support its understanding, use, or maintenance.
executable specificationproduced by · An executable specification is a machine-runnable description of expected system behavior that can automatically verify whether an implementation satisfies its requirements.
product ownerused by · A product owner is a role responsible for representing product needs and value and guiding the priorities and direction of product work.
reporthas part · A report is a structured presentation of information, findings, measurements, analysis, or outcomes for a defined audience or purpose.
commentcontrasts with · A comment is text or markup designated by a format's syntax as an annotation or non-content rather than ordinary executable or data content.
behavior-driven developmentpart of · Behavior-driven development is a collaborative software practice that specifies and validates expected behavior through human-readable examples meaningful to technical and nontechnical stakeholders.

This explainer was generated by Manning's knowledge graph from the text of The Art of Code. The section links point to the parts of the book it draws on.