technical-writing

Installation
SKILL.md

Technical Writing

This skill guides internal engineering documentation (specs, architecture, runbooks, API references, changelogs)—not marketing or end-user product docs unless the task says otherwise.

How to use it: follow Instructions (Steps 1–5) in order. For copy-paste skeletons, use Step 2 and Document templates. For the user’s final document, use normal Markdown and three backticks for code fences. In this skill file only, some templates use four leading backticks on the outer fence so inner triple-backtick samples do not break the fence pairing.

When to use this skill

  • Writing technical specifications
  • Creating architecture documentation
  • Documenting system designs
  • Writing runbooks and operational guides
  • Creating developer documentation
  • API documentation
  • User manuals and guides
  • Release notes and changelogs

Instructions

Related skills

More from bjornmelin/dev-skills

Installs
1
GitHub Stars
2
First Seen
2 days ago