Chapter 7. Living documentation

This chapter covers

  • Understanding living documentation
  • Helping new team members with living documentation
  • Defining domain concepts consistently
  • Documenting product changes and troublesome areas

Everybody who’s ever worked with software has probably dealt with documentation at some point. Documentation can be provided on paper or online, or on digital or analog media, such as audiotape or CDs. SBE introduces a different type of documentation.

Definition

Living documentation—Documentation that changes along with the system it describes. Thanks to frequently validated acceptance tests, the living documentation system is aware of changes you make to the system; if the changes yield different results than ...

Get Writing Great Specifications now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.