
Living Documentation
Cyrille Martraire · 2019
Writing, design and web craft › Data visualization and visual communication
#13,793 most recommended
Hacker News
2
mentions by 2 people · top 79% of 15,732 books
Open Library
4.00★★★★★★★★★★
1 rating · 2 want to read
Wikipedia
—
No article yet
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
In the commenters’ own words
Warning: opening a can of worms. Ann Blair is a great source on general, but there are so many facets to this topic here's a list that I have read or am going…
Reminds me of my favorite quote from Living Documentation by Cyrille Martraire: > Software development is all about knowledge and decision-making based on…
What Open Library readers say 4.00 from 1 rating
- 50
- 41
- 30
- 20
- 10
- 2 want to read
- 0 reading
- 1 have read
Only 1 rating: treat the average as a hint.
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
Read next: its neighbours on the mosaic
Information ArchitectureLouis Rosenfeld · 2015 · recommended by 1 person · similar by subject and what people say about it
Trees, maps, and theoremsJean-Luc Doumont · 2009 · recommended by 3 people · similar by subject and what people say about it
Paper machinesMarkus Krajewski · 2011 · recommended by 1 person · similar by subject and what people say about it
The Craft of ResearchWayne C. Booth · 1995 · recommended by 4 people · similar by subject and what people say about it
Too much to knowAnn Blair · 2010 · recommended by 1 person · similar by subject and what people say about it
Antinet ZettelkastenScott Scheper · 2022 · recommended by 2 people · similar by subject and what people say about it
System for WritingBob Doto · 2024 · recommended by 3 people · similar by subject and what people say about it
Extended MindAnnie Murphy Paul · 2021 · recommended by 2 people · similar by subject and what people say about it
The Bullet Journal methodRyder Carroll · 2018 · recommended by 4 people · loosely similar by subject
The Great Mental ModelsFarnam Street · 2020 · recommended by 5 people · loosely similar by subject
Carrier Bag Theory of FictionUrsula K. Le Guin · 1986 · recommended by 0 people · loosely similar by subject
Index, A History of theDennis Duncan · 2022 · recommended by 0 people · loosely similar by subject
A writer's notebookWilliam Somerset Maugham · 1949 · recommended by 0 people · loosely similar by subject
Making work visibleDominica DeGrandis · 2017 · recommended by 4 people · similar by subject and what people say about it
Docs for DevelopersJared Bhatti · 2021 · recommended by 4 people · similar by subject and what people say about it
Documenting Software ArchitecturesPaul Clements · 2002 · recommended by 2 people · similar by subject and what people say about it
Dynamics of software developmentMcCarthy, Jim · 1995 · recommended by 10 people · similar by subject and what people say about it
Software Design DecodedMarian Petre · 2016 · recommended by 1 person · similar by subject and what people say about it
Envisioning InformationEdward R. Tufte · 1990 · recommended by 31 people · similar by subject and what people say about it
Changing MindsAndrea diSessa · 2000 · recommended by 1 person · similar by subject and what people say about it
Science of Managing Our Digital StuffOfer Bergman · 2016 · recommended by 0 people · similar by subject and what people say about it
Data and RealityWilliam Kent · 1978 · recommended by 15 people · similar by subject and what people say about it
The macroscopeJoël de Rosnay · 1979 · recommended by 2 people · similar by subject and what people say about it
Understanding SoftwareMax Kanat-Alexander · 2017 · recommended by 2 people · similar by subject and what people say about it