Glossary
Glossary Documentation-Driven Development

Documentation-Driven Development

Also known as: ddd, docs-driven development, readme-driven development
PracticesDocumentation

Definition

Writing the documentation first, the README, guide or usage example a person would read, and building what it describes, so the explanation is the spec and the proof that the thing can be adopted

Close kin of Tom Preston-Werner's README Driven Development (2010): if the docs are hard to write, the design is wrong, and it is cheaper to find out before the code exists. The acronym collides: DDD far more often means Domain-Driven Design (Eric Evans, 2003), modeling software around a business domain and its ubiquitous language. Say which one on first use.

Tech

In this lab the documentation is part of the product. A lab or guide is written so a reader can adopt the thing it describes, and the site is the demonstration. The Domain-Driven Design sense of DDD lives in the domain-modeling skill and CONTEXT.md.

Related Terms

  • a: Appearance
  • ?: Keyboard shortcuts