technical-writing-clarity

Community

Make docs clear and actionable.

Authoredwifiguy
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This skill helps engineers and technical writers produce concise, reader-friendly documentation by applying proven clarity principles and structured templates.

Core Features & Use Cases

  • Structured clarity rules: Lead with purpose, keep paragraphs focused, and prefer active voice to improve comprehension.
  • Practical runbook templates: Use tested structure for overview, prerequisites, steps, verification, and troubleshooting.
  • Jargon control & examples: Replace vague terms with concrete examples and defined terminology to reduce ambiguity.
  • Use Case: When drafting a project README or runbook, apply these guidelines to dramatically improve readability and usefulness.

Quick Start

Provide the draft you want to clarify, and I will rewrite it for maximum clarity.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: technical-writing-clarity
Download link: https://github.com/edwifiguy/era-agents-ops/archive/main.zip#technical-writing-clarity

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.