liveBook · Manning

Inverted pyramid

As explained in Writing for Developers: Blogs that get read

A writing pattern that presents the most important information first and progressively less essential detail afterward.

The inverted pyramid puts critical information first, then adds progressively less essential detail. Frontload enough context for readers to understand the post’s purpose and value before they click away. section 5.2.3

Apply the pattern while revising:

  • State what the post is about and why it matters near the beginning. section 5.2.3
  • Offer useful details early without revealing every detail or removing reasons to continue. section 5.2.3
  • Treat bug-hunting posts differently when preserving the culprit as part of the reading experience. section 5.2.3

A different contract with the reader

A summer blockbuster can save its plot twist for the end because viewers are relatively captive. A blog post should not make readers work through 2,000 words before discovering why the result matters. section 5.2.3

Table 5.2 Helpful vs. unhelpful headings (view table figure)

Unhelpful heading

Better option

pg_fakedb

Why we built a FakeDB <> Postgres migration tool in Zig

@cImport and translate-c

How we achieved C interoperability

catch unreachable

Comparing Zig’s error handling to Rust’s

Use specific headings to expose the subject and benefit early; replace cryptic labels such as “pg_fakedb” with headings that state the project and reader-relevant question. section 5.2.3

How Writing for Developers: Blogs that get read covers it

How deep it goes
Defines the ordering principle and gives introduction guidance, but defers detailed treatment to an external article.
Examples
Contrasts a blockbuster’s delayed twist with a blog post that reveals its value before 2,000 words.
What you can do after
Apply it via a frontloaded introduction that states the goal, reader benefit, and useful early details.
How it connects
Connects introductions, reader goals, headings, blog posts, and bug-hunting posts.

This explainer was generated by Manning's knowledge graph from the text of Writing for Developers: Blogs that get read. The section links point to the parts of the book it draws on.