technical-clarity

Community

Clear, accessible technical writing for learners.

Authorkhanaleema
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Improves technical documentation by identifying readability gaps, reducing gatekeeping, and ensuring terms are defined on first use to boost learner comprehension.

Core Features & Use Cases

  • Audience-focused reviews: Analyzes audience level and adjusts language accordingly.
  • Jargon management: Defines terms on first use and limits undefined terms per paragraph.
  • Show-Then-Explain: Encourages concrete examples before abstract explanations.
  • Accessibility considerations: Checks for alt text, semantic structure, and inclusive language.

Quick Start

Request a readability review:

  • "Evaluate this section for A2 readers and provide inline examples."
  • "Explain this paragraph with a concrete example first, then abstract rules."

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-clarity
Download link: https://github.com/khanaleema/PhysicalAI-Book/archive/main.zip#technical-clarity

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