OpenParable
Skip to content
← Back to skills

Technical Writing Clarity

Business
technical-writing-clarity

Technical 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.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. 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 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.