ReddRadar
Agent skill
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 this agent skill to your Project
npx add-skill https://github.com/aiming-lab/MetaClaw/tree/main/memory_data/skills/technical-writing-clarity
SKILL.md
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 scriptnotThe 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.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
aiming-lab/MetaClaw
structured-progress-update
Use this skill when summarizing progress on an ongoing project or multi-step task. Give a clear, scannable status report whenever asked for an update or at the end of a work session.
aiming-lab/MetaClaw
async-communication-etiquette
Use this skill when writing messages in async channels (Slack, GitHub issues, email threads) where the reader may not have context and cannot ask follow-up questions immediately.
aiming-lab/MetaClaw
idempotent-script-design
Use this skill when writing scripts, cron jobs, data pipelines, or any automated process that may be run multiple times. Design every operation to be safely re-runnable without side effects.
aiming-lab/MetaClaw
secrets-management
Use this skill when handling API keys, passwords, tokens, private keys, or any sensitive credential. Never hardcode secrets in source code — apply this whenever the word "key", "token", "password", or "secret" appears in the task.
aiming-lab/MetaClaw
input-validation-and-sanitization
Use this skill when implementing any endpoint, form handler, CLI tool, or function that accepts external input. Validate and sanitize all untrusted data before processing — never assume input is safe.
aiming-lab/MetaClaw
graceful-error-recovery
Use this skill when a tool call, command, or API request fails. Diagnose the root cause systematically before retrying or changing approach. Do not retry the same failing call without first understanding why it failed.
Didn't find tool you were looking for?