Making documentation people actually read

Back to list2024-12-18
You

Our README is thorough and nobody reads it. Why?

ChatGPT

Because it answers questions in the author's order, not the reader's. Lead with what the thing does in one sentence, then how to run it, then the caveats. Anything a reader cannot act on in the first screen is reference material and belongs further down.