liveBook · Manning

How we built it

As explained in Writing for Developers: Blogs that get read

A blog post pattern that explains how a technical system or project was created.

A “How We Built It” post explains how a team created an impressive technical system, solved an unusually difficult problem, or achieved demanding scale. Its readers want practical learning, inspiration, and discovery—not merely a success announcement. The strongest posts contribute reusable engineering knowledge even when their exact results cannot be reproduced. section 10.0 section 10.4.1

Treat the post as both a technical narrative and a public review request. Explain important decisions, rejected approaches, tools, constraints, and trade-offs; anticipate objections instead of hiding behind an impressive outcome. Use a formal team voice when speaking for an organization, while keeping the storyline clear and the details accessible. section 10.4.3 section 10.4.4 section 10.1.3

Build the post deliberately:

  • Agree on what may be revealed, including legal and tactical limits, before drafting. section 10.5.1
  • Show architecture, algorithms, and nonintuitive decisions with diagrams, graphs, images, or screenshots. section 10.5.2
  • Include practical tidbits such as code snippets, tool choices, academic references, and lessons from failed attempts. section 10.4.1 section 10.4.2
  • Check links, examples, references, and code carefully; plan time for review, graphics, approvals, and responses. section 10.5 section 10.5.3

Scale with usable detail

A notification-rate-limiter post serving eight billion notifications per day demonstrates the pattern’s appeal through extreme scale. Its database schemas make the article useful to readers, while unexplained acronyms and overly detailed images make it harder to follow. Define niche terms and make visuals readable at their displayed size. section 10.3.3

How Writing for Developers: Blogs that get read covers it

How deep it goes
Explains architecture, tools, decisions, alternatives, and constraints with visuals, but may stop short of reproducible implementation.
Examples
Uses large-scale systems, home projects, database schemas, code snippets, diagrams, screenshots, academic references, and failed attempts.
What it assumes
Assumes firsthand experience with a substantial engineering project while teaching readers through practical context and explanatory visuals.
What you can do after
Builds a carefully scoped, visually clear, technically candid post that teaches beyond its original project.
How it connects
Connects system architecture, algorithms, programming languages, tools, project planning, technical communication, and peer review.

Related concepts

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.