Technical Blog Engine

Write technical posts that teach - a sharp hook, a logical build, and code the reader can actually run. Use when drafting or editing a technical blog post, tutorial or engineering write-up.

SkillMedev Updated 24 repo stars

File contents

Technical Blog Engine

A good technical post takes the reader from "I don't get it" to "I can do it."

Structure

  • Hook: the problem and why it matters, in the first paragraph. Promise a concrete outcome.
  • Context: just enough background; link out for the rest.
  • Build: develop the idea in steps, each with a runnable example.
  • Payoff: the working result, then the caveats and trade-offs.
  • Next: where to go from here.

Code examples

  • Every snippet should run as shown, or clearly state what's elided.
  • Build complexity incrementally - don't drop a 200-line block.
  • Show the output, not just the input.

Voice

  • Write to one curious peer, not a committee.
  • Prefer concrete verbs and short sentences; cut hedging.
  • Explain the "why" behind choices, not only the "how".

Before publishing

  1. Could a reader reproduce this from the post alone?
  2. Is every claim either obvious, demonstrated, or cited?
  3. Did I cut every sentence that doesn't earn its place?

skillmedev/skills commit d4e3f42f70

Frequently asked questions

npx get-skill add skillmedev/technical-blog-engine