Technical Writing
New Grub Street and the Documentation Debt
A literary guide to writing things down before the last maintainer resigns
A bracing reminder that undocumented software is merely a Victorian serial with missing instalments.
Gissing turns his severe attention to README files, runbooks, API references, and the melancholy economics of keeping them current. This volume explains how to write documentation that survives reorganisation, release pressure, and the colleague who insists the code is self-explanatory.
Contents
- The Profession of Letters and Release Notes
- README as Social Contract
- Runbooks for the Respectably Desperate
- The Index, the Glossary, and the Single Source of Truth
Published by Austenpunk, the distinguished imprint for engineers who believe that every production incident would be improved by a stronger sense of narrative irony.
This essential volume combines literary feeling, technical anxiety, and just enough documentation to suggest that somebody once understood the system.
