Written by [Author Name]. Edited by Callout’s AI editor, which suggested [N] changes; the author accepted [N] and rejected [N], and approved the final text. [Optional: “The author used [tool] for [purpose].”]
[Placeholder opening paragraph. In a real piece, this states the single most important point in the first two sentences: what the author did, and what changed as a result, ideally with a number.]
[Placeholder second paragraph: why this matters to a working documentation practitioner now, and who this piece is for.]
The problem #
[Placeholder: the situation before the change. What the docs, the team and the constraints looked like. Real pieces give specifics: page counts, team size, tooling, and who asked for what.]
[Placeholder: the trigger. Why this had to change now.]
What we tried #
[Placeholder: the approach, including the options considered and rejected. Contributors are asked to name the alternatives they didn’t choose and why.]
# [Placeholder code sample]
# Real samples must run, or be labelled "illustrative".
example-command --flag value
[Placeholder tip callout: a short, practical aside a reader can apply immediately.]
How we measured it #
[Placeholder: what was measured, over what period, and how. Callout’s style guide requires every number to carry its context: the base, the period and the method.]
What happened #
[Placeholder: the result, with numbers where possible, and an honest account of what didn’t work.]
[Placeholder pull quote: one sentence from the piece, chosen by the author.]
[Placeholder warning callout: a pitfall the author hit, so readers don’t.]
What I’d tell a peer #
[Placeholder: the transferable lesson, and what the author would do differently. Every Rebuild and Agent-Ready piece ends with this section.]
- [Placeholder takeaway one]
- [Placeholder takeaway two]
- [Placeholder takeaway three]
Corrections
[Placeholder: dated correction notes appear here if anything is corrected after publication. For example: “[Date]: An earlier version gave the wrong figure for X. It has been corrected.”]
Get pieces like this weekly
The Index: the best writing on documentation from across the field, plus new Callout pieces. Written by the AI editor and labelled as such.