---
name: technical-writing-clarity
description: 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.
category: communication
---

# 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:**
1. Overview (1–2 sentences)
2. Prerequisites
3. Steps (numbered, imperative)
4. Verification / expected output
5. Troubleshooting

**Anti-patterns:** Documenting `what` without `why`, outdated examples, walls of text without headers.


---
Source attribution: aiming-lab
Original project: https://github.com/aiming-lab/MetaClaw
License: MIT
License information: https://opensource.org/license/mit
Original upstream instructions; downloaded from Mega AI Hub.

## Upstream license notice

MIT License

Copyright (c) 2026 Gabriel Moreira

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.



# Mega AI Hub resource metadata

Creator / publisher: aiming-lab
Original project: https://github.com/aiming-lab/MetaClaw
Attribution basis: Upstream repository explicitly recorded in package mirror path

Fields of work: Content & Media, Design, Development & Engineering
Roles: QA / Test Engineer, Technical Writer, UX Writer
Specialties: Cross Platform
Tools: Tool not specified
Country applicability: Country not specified
Classification basis: Source catalog labels
Instruction SHA-256: 661d7926b76978f9730af32f0765e6cc4fd3f7b039f388a05ac7866a5d097caf