MetaClaw technical-writing-clarity

Use this skill when writing documentation, READMEs, technical specs, runbooks, or any text that explains a system or process to other engineers. Apply before writing any developer-facing document.

install

source · Clone the upstream repo

git clone https://github.com/aiming-lab/MetaClaw

Claude Code · Install into ~/.claude/skills/

T=$(mktemp -d) && git clone --depth=1 https://github.com/aiming-lab/MetaClaw "$T" && mkdir -p ~/.claude/skills && cp -r "$T/memory_data/skills/technical-writing-clarity" ~/.claude/skills/aiming-lab-metaclaw-technical-writing-clarity && rm -rf "$T"

manifest: memory_data/skills/technical-writing-clarity/SKILL.md

source content

Technical Writing for Clarity

Principles:

Lead with the purpose: What is this document for and who is it for?
One idea per paragraph. Long paragraphs hide key information.
Use active voice:
```
Run the script
```
not
```
The script should be run
```
.
Concrete over abstract: Show an example rather than describing it abstractly.
Avoid jargon you have not defined unless the audience definitely knows it.

Structure for runbooks/how-tos:

Overview (1–2 sentences)
Prerequisites
Steps (numbered, imperative)
Verification / expected output
Troubleshooting

Anti-patterns: Documenting

what

without

why

, outdated examples, walls of text without headers.