DeepRead
Cover of Living Documentation

Living Documentation

Cyrille Martraire · 2019

Writing, design and web craft › Data visualization and visual communication

#13,793 most recommended

About the book

A practical guide to producing software documentation that stays current with the system it describes, by generating it from or tying it to artifacts a project already has, such as source code, tests, build pipelines, and diagrams. It covers documentation for developers and other stakeholders across the software lifecycle, along with the tools and team practices that make this work. Its central claim is that documentation goes stale when it is maintained apart from the system, and that the remedy is to make documentation a living part of the development process rather than a separate deliverable. Martraire argues that the most valuable knowledge sharing happens through collaboration and conversation, with documentation serving as a durable, automatically checked record of that shared understanding. The book presents patterns for generating documentation from code and tests and keeping it verified against the running system, and it treats knowledge sharing as the main purpose of documentation.

Written by Claude from what it knows of this book.

What Hacker News says 50% recommend · 0% critical

00.512024202520262024 peak · 1
This bookAverage book in Data visualization and visual communication

In the commenters’ own words

What Open Library readers say 4.00 from 1 rating

  1. 50
  2. 41
  3. 30
  4. 20
  5. 10
  • 2 want to read
  • 0 reading
  • 1 have read

Only 1 rating: treat the average as a hint.

Open Library’s page for the book

What critics say, via Wikipedia

No Wikipedia article about this book yet, so no critics to quote.

Reddit communities — coming later

Details

First published
2019
ISBN
9780134689425
Editions known
6 at Open Library
Open Library
OL21156747W

Electronic data processing documentation

Explore in the mosaic

Read next: its neighbours on the mosaic

  • Information Architecture
    Louis Rosenfeld · 2015 · recommended by 1 person · similar by subject and what people say about it
  • Trees, maps, and theorems
    Jean-Luc Doumont · 2009 · recommended by 3 people · similar by subject and what people say about it
  • Paper machines
    Markus Krajewski · 2011 · recommended by 1 person · similar by subject and what people say about it
  • The Craft of Research
    Wayne C. Booth · 1995 · recommended by 4 people · similar by subject and what people say about it
  • Too much to know
    Ann Blair · 2010 · recommended by 1 person · similar by subject and what people say about it
  • Antinet Zettelkasten
    Scott Scheper · 2022 · recommended by 2 people · similar by subject and what people say about it
  • System for Writing
    Bob Doto · 2024 · recommended by 3 people · similar by subject and what people say about it
  • Extended Mind
    Annie Murphy Paul · 2021 · recommended by 2 people · similar by subject and what people say about it
  • The Bullet Journal method
    Ryder Carroll · 2018 · recommended by 4 people · loosely similar by subject
  • The Great Mental Models
    Farnam Street · 2020 · recommended by 5 people · loosely similar by subject
  • Carrier Bag Theory of Fiction
    Ursula K. Le Guin · 1986 · recommended by 0 people · loosely similar by subject
  • Index, A History of the
    Dennis Duncan · 2022 · recommended by 0 people · loosely similar by subject
  • A writer's notebook
    William Somerset Maugham · 1949 · recommended by 0 people · loosely similar by subject
  • Making work visible
    Dominica DeGrandis · 2017 · recommended by 4 people · similar by subject and what people say about it
  • Docs for Developers
    Jared Bhatti · 2021 · recommended by 4 people · similar by subject and what people say about it
  • Documenting Software Architectures
    Paul Clements · 2002 · recommended by 2 people · similar by subject and what people say about it
  • Dynamics of software development
    McCarthy, Jim · 1995 · recommended by 10 people · similar by subject and what people say about it
  • Software Design Decoded
    Marian Petre · 2016 · recommended by 1 person · similar by subject and what people say about it
  • Envisioning Information
    Edward R. Tufte · 1990 · recommended by 31 people · similar by subject and what people say about it
  • Changing Minds
    Andrea diSessa · 2000 · recommended by 1 person · similar by subject and what people say about it
  • Science of Managing Our Digital Stuff
    Ofer Bergman · 2016 · recommended by 0 people · similar by subject and what people say about it
  • Data and Reality
    William Kent · 1978 · recommended by 15 people · similar by subject and what people say about it
  • The macroscope
    Joël de Rosnay · 1979 · recommended by 2 people · similar by subject and what people say about it
  • Understanding Software
    Max Kanat-Alexander · 2017 · recommended by 2 people · similar by subject and what people say about it