Technical Writing Clarity
Businesstechnical-writing-clarityTechnical Writing Clarity is an Agent Skill for business published in the aiming-lab/MetaClaw repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
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.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/aiming-lab/MetaClaw/blob/HEAD/memory_data/skills/technical-writing-clarity/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/technical-writing-clarity, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
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.