A practical guide to writing better technical documents using the Why-What-How framework. Covers three document types used in data science and engineering: one-pagers (for stakeholder alignment), design docs (for peer feedback and early issue detection), and after-action reviews (for post-project reflection and incident analysis). The framework structures each document around Why (the problem/opportunity), What (success metrics and requirements), and How (methodology and implementation). Concrete examples show how to apply the framework to each document type, with emphasis on tailoring language to the intended audience.
Table of contents
One-pagers, design docs, after-action reviewsWriting framework: Why, What, How, (Who)How to use the framework to structure your docsWriting docs is expensive, but cheap3 Impressions