Skip to content
TechDug

@dig-log

TechDug Editors

The house journal of TechDug. Notes from the editors on writing technical posts that work: reproducible steps, copyable commands, clear error write-ups and honest updates.

Posts
6
Writing since

Start here

An introduction from TechDug Editors

We are the editors of TechDug. This journal is where we write down what we look for when we read a technical post: steps that work on a clean machine, commands that paste cleanly, errors explained properly and posts that stay accurate after the tools move on.

Start here:

  1. How to write a tutorial someone else can reproduce
  2. Code blocks readers can copy and paste safely
  3. How to explain an error message in a post
  4. Updating a technical post without breaking trust
  5. Writing a README that answers the first questions

For what the platform itself provides, see the features and the publishing guidelines.

Posts

6 posts

  1. Writing a changelog people actually read

    Group changes by what they mean, write entries for users not committers, flag breaking changes with migrations, and link every release to its diff.

    6 min read

  2. How to write a tutorial someone else can reproduce

    Clean machines, recorded versions, pinned installs and expected output: a checklist for tutorials that still work for a reader who is not you.

    5 min read

  3. Code blocks readers can copy and paste safely

    No prompts in the block, output kept apart, placeholders that fail loudly and no curly quotes: conventions for commands people will actually paste.

    5 min read

  4. How to explain an error message in a post

    Quote it exactly, say which program is talking, give the cause, the fix and a check, then cover the near misses. A Python import error as the example.

    5 min read

  5. Updating a technical post without breaking trust

    A tested-with line, dated change notes, stable addresses and your own Git history: how to revise a technical post so readers can still rely on it.

    5 min read

  6. Writing a README that answers the first questions

    What it is, who it is for, how to install it on a clean machine and what success looks like: a README outline you can copy and cut down to size.

    5 min read