liveBook · Manning

Writing

As explained in Writing for Developers: Blogs that get read

The practice of composing text to communicate ideas, information, or experiences in a way that sustains reader interest.

Writing communicates engineering ideas by turning experience, expertise, and working thoughts into text readers can understand, trust, and remember. Aim for an authentic conversational voice rather than research-paper formality. section 1.1 section 5.5.1

Use a lightweight process that separates getting ideas down from improving them:

  • Start with the goal, target audience, and distinctive perspective. Check first whether the topic is safe to discuss, especially around unreleased work, closed source, patents, or unpatched vulnerabilities. section 4.2
  • Create an outline, mind map, or other loose structure if it helps; otherwise begin wherever the ideas are easiest to express. section 4.4.2 section 4.8
  • Produce a working draft quickly. Dictate to a rubber duck, explain the idea to a colleague, or type directly; leave placeholders instead of stopping for polish. section 4.4.1 section 4.4.2
  • Treat the draft as a minimum viable product: check for major omissions first, then revise for clarity, concision, scanability, and reader relevance. section 4.0 section 5.7
  • Read the result aloud, strengthen prominent clunky sentences, and make the introduction explicit about the reader’s benefit and your distinctive angle. section 5.7

From engineering experience to useful prose

After solving a painful bug, record impressions while the details are fresh. Capture diagrams, side notes, and relationships as well as sentences; later, shape those notes into a lessons-learned or bug-hunt post. A comparable working-draft exercise plans, writes, and optimizes a post about implementing a database migration tool in Zig. section 11.1.1 section 4.0 section 8.5

Writing can also support sustained mastery. A book forces rigorous study, exposes known and unknown gaps, and requires repeated rewriting and response to editorial and reader feedback. The commitment demands realistic long-term time and persistent momentum. section 17.1.3 section 17.1.4 section 17.2.2

How Writing for Developers: Blogs that get read covers it

How deep it goes
Explains preparation, drafting, blocker removal, revision, and longer-form practice, while deferring detailed sentence-level techniques to optimization.
Examples
Uses rubber-duck dictation, colleague conversations, bug hunts, lessons-learned diagrams, and a Zig database-migration post.
What it assumes
Assumes an engineering experience or idea to share, but teaches how to find structure, overcome drafting resistance, and address reader knowledge.
What you can do after
Practice/perform writing by preparing, drafting rapidly, gathering early feedback, revising for readers, and sustaining progress on longer projects.
How it connects
Connects writing with audience analysis, outlining, feedback, revision, self-reflection, technical blogging, and book writing.

Also explained in

Compare how 2 books explain writing →

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.