DeepRead
Cover of Docs for Developers

Docs for Developers

Jared Bhatti, Heidi Waterhouse · 2021

Programming and computer science › Software design and clean code

#5,159 most recommended

About the book

A practical guide to writing developer documentation as part of the software development lifecycle, covering user research, friction logs, READMEs, API references, tutorials, conceptual material, release notes, information architecture for search, publishing, and analytics-based measurement. It follows a fictional team of developers as they launch a new product, with templates and principles meant to be adapted to other organizations. Documentation is a core engineering concern rather than an afterthought, and writing and programming share enough craft that developers can learn to do both well. Poor documentation reduces developer productivity, limits a project's scalability and adoption, and hurts accessibility, so it can sink a project. The guide's remedy is to build documentation into each stage of development, starting from understanding users' frustrations and continuing through publishing, measurement, and maintenance alongside regular code releases.

Written by Claude from what it knows of this book.

What Hacker News says 57% recommend · 0% critical

051020212022202320242022 peak · 7
This bookAverage book in Software design and clean code

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
  • 6 want to read
  • 1 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

The threads it came up in

Details

First published
2021
ISBN
9781484272169
Editions known
5 at Open Library
Open Library
OL24645251W

Explore in the mosaic

Read next: its neighbours on the mosaic

  • Developing quality technical information
    Gretchen Hargis · 2004 · recommended by 3 people · similar by subject and what people say about it
  • Software Engineering at Google
    Titus Winters · 2020 · recommended by 21 people · similar by subject and what people say about it
  • Web design for developers
    Brian P. Hogan · 2009 · recommended by 4 people · similar by subject and what people say about it
  • Soft Skills
    John Z. Sonmez · 2015 · recommended by 14 people · similar by subject and what people say about it
  • Too big to know
    David Weinberger · 2012 · recommended by 1 person · loosely similar by subject
  • Dynamics of software development
    McCarthy, Jim · 1995 · recommended by 10 people · similar by subject and what people say about it
  • The Elements of Style
    William Strunk, Jr. · 1918 · recommended by 131 people · 2 people recommended both
  • Design for Developers
    Stephanie Stimac · 2023 · recommended by 2 people · similar by subject and what people say about it
  • Designing Data-Intensive Applications
    Martin Kleppmann · 2017 · recommended by 457 people · similar by subject and what people say about it
  • The DevOps handbook
    Gene Kim · 2016 · recommended by 22 people · similar by subject and what people say about it
  • How Google Tests Software
    James A. Whittaker · 2012 · recommended by 3 people · similar by subject and what people say about it
  • The Software Craftsman
    Sandro Mancuso · 2014 · recommended by 9 people · similar by subject and what people say about it
  • The Art of Readable Code
    Dustin Boswell · 2011 · recommended by 11 people · similar by subject and what people say about it
  • Software Craftsmanship
    Pete McBreen · 2001 · recommended by 4 people · similar by subject and what people say about it
  • Beautiful Code
    Andy Oram · 2007 · recommended by 48 people · similar by subject and what people say about it
  • Exercises for Programmers
    Brian P. Hogan · 2015 · recommended by 6 people · similar by subject and what people say about it
  • Ask Your Developer
    Jeff Lawson · 2021 · recommended by 3 people · similar by subject and what people say about it
  • The Pragmatic Programmer
    Andy Hunt · 1999 · recommended by 353 people · similar by subject and what people say about it
  • Letting go of the words
    Janice Redish · 2012 · recommended by 6 people · similar by subject and what people say about it
  • Team Geek
    Ben Collins-Sussman · 2012 · recommended by 11 people · similar by subject and what people say about it
  • An Elegant Puzzle
    Will Larson · 2019 · recommended by 41 people · similar by subject and what people say about it
  • Software Developer's Career Handbook
    Michael Lopp · 2022 · recommended by 3 people · similar by subject and what people say about it
  • The passionate programmer
    Chad Fowler · 2011 · recommended by 31 people · similar by subject and what people say about it
  • Working with coders
    Patrick Gleeson · 2017 · recommended by 1 person · similar by subject and what people say about it