explain
Explain
Produce one rich, self-contained HTML document that makes a reader genuinely understand something. Not a summary, not a review — an explanation, written to be read once, from the top, by a skilled engineer who does not know this area.
Core principle: comprehension, not judgement. The reader should finish able to reason about the thing. Whether it is any good is a different job.
The three invariants
These are the whole discipline. Everything else is craft.
1. Never comment on correctness. No bugs, no risks, no "this should be", no suggested fixes, no severity labels, no "note that this could fail if". If you notice a problem, stay silent here and mention it in chat after handing over the document. An explanation that editorialises stops being trusted as an explanation.