technical-clarity

Analyze technical documentation readability and recommend targeted edits.

Updated Dec 10, 2025
One-click install
npx skills add https://github.com/khanaleema/PhysicalAI-Book --skill technical-clarity-khanaleema
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-clarity
Source: https://github.com/khanaleema/PhysicalAI-Book/tree/main/.gemini/skills/technical-clarity
Command: npx skills add https://github.com/khanaleema/PhysicalAI-Book --skill technical-clarity-khanaleema

SYSTEM DOCUMENTATION & REQUIREMENTS

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

Frequently Asked Questions about technical-clarity

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I make technical documentation more accessible to learners with different backgrounds?

Technical clarity improves accessibility by analyzing readability gaps, defining jargon on first use, and adjusting language for specific audience levels. It reviews API references, guides, and manuals to ensure terms are introduced before use and examples precede abstract rules, removing gatekeeping barriers that block comprehension.

What's the best way to reduce jargon and undefined terms in technical writing?

Jargon management in technical clarity involves auditing terminology, defining each term on first use, and limiting undefined terms per paragraph. The Skill identifies where terms lack definitions and recommends concrete examples before abstract explanations, ensuring readers at all levels grasp concepts.

How do I evaluate if my technical documentation is too complex for my audience?

A readability gap analysis compares your documentation against specific learner levels—such as A2 readers or domain novices—and identifies opacity points where language, structure, or missing examples prevent comprehension. The Skill delivers actionable rewrite recommendations with concrete examples justifying each edit.

Can I improve onboarding content and user manuals for accessibility at the same time?

Yes. Technical clarity reviews onboarding content, user manuals, API references, and developer guides for both readability and accessibility, checking for alt text, semantic structure, and inclusive language while reducing gatekeeping and ensuring terms are defined on first use.

What does a readability review for technical documentation include?

A readability review analyzes audience comprehension level, audits terminology for undefined jargon, checks whether examples precede explanations, and evaluates accessibility features like alt text and semantic structure. It returns targeted rewrite recommendations with justification and concrete inline examples for each gap.

When should I use show-then-explain instead of explaining first in technical writing?

Show-before-tell applies whenever learners benefit from concrete examples before abstract rules—especially in API references, developer guides, and onboarding content. Technical clarity identifies paragraphs where this pattern would improve comprehension and recommends placing examples first, then rules, to reduce cognitive load.