Templates · Writing & publishing
Engineering blog post (how we built it) template
For a launch, a migration, an outage write-up or a performance win. Origin: The house style of engineering blogs at Stripe, Netflix, Cloudflare and Slack: a technical narrative from problem to result, written for engineers outside the company.
Sections
- Hook (the problem in one paragraph)
- Context and constraints
- What we tried first
- The approach
- Results with numbers
- What we would do differently
- Where this goes next
How a tough reader scores it
When you score a draft against this format, the Critic evaluates this engineering blog post. The weights add up to 100; the fixes for the weakest criteria arrive as cards in the editor.
| Criterion | Weight |
|---|---|
| The opening states a real problem and a stake in the first paragraph | 15 |
| Technical decisions are explained with the alternatives that were rejected | 20 |
| Results are measured, with the method and the before state | 20 |
| Readable by an engineer outside the company, jargon glossed, no internal names | 15 |
| Honest about what went wrong or remains unsolved | 15 |
| Structure carries the reader from problem to result without detours | 10 |
| Length fits the story, 1,500 to 2,500 words | 5 |
How it works in SecondPen.ai
Open the template and the editor writes the blank once, with a line of guidance under each heading that you delete as you fill it in. Write your abstract and the editor names the format it reads like. Ask for a document with a slash command and it offers to start from the matching format. When the draft is ready, the Critic scores it against the criteria above, the way this format's toughest reader would, and the three highest-leverage fixes become Editor cards.
More in Writing & publishing
- Essay (Paul Graham)an idea you want to work out in public
- Op-ed (The OpEd Project)an opinion piece for a newspaper, a trade publication or a company blog taking a position
- Listiclea roundup, a set of tips, tools or lessons that do not need to be read in order
- Tutorial (Diátaxis)a getting-started guide or a "build your first X" post
- How-to guide (Diátaxis)"How to do X in Y" posts and internal guides
- Explainer"What is X and why does it matter", a concept, a controversy or a system explained for a curious reader
- Launch announcement posta product, feature or company launch on a blog or a changelog
- Newsletter issuea weekly or monthly issue to subscribers