technical-writing

Enforce clarity and consistency guidelines across Jira issues, design docs, READMEs, and CLAUDE files.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/cyarie/cyarie-claude-plugin --skill technical-writing-cyarie
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/cyarie/cyarie-claude-plugin/tree/main/skills/technical-writing
Command: npx skills add https://github.com/cyarie/cyarie-claude-plugin --skill technical-writing-cyarie

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Technical writing often suffers from unclear, inconsistent, and hard-to-translate content across Jira issues, design docs, READMEs, and CLAUDE files. This skill provides structured guidelines to improve clarity, consistency, and global accessibility.

Core Features & Use Cases

  • Clarity-first rules: short, actionable sentences; explicit nouns; avoidance of jargon and contractions.
  • Language and structure guidance: active voice, present tense, parallel lists, and consistent terminology; applies to drafting, editing, and reviewing technical content.
  • Use cases: creating Jira issues, drafting design documents, updating READMEs, and writing CLAUDE prompts.

Quick Start

Apply these rules to your next technical document by rewriting it for clarity and global accessibility.

Frequently Asked Questions about technical-writing

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

FAQPage Schema
How do I write clear technical documentation for READMEs and design docs?

Write clear technical documentation by enforcing short, actionable sentences, active voice, and explicit nouns. This approach improves readability and consistency across design docs, READMEs, and CLAUDE files.

What is the best way to make technical writing translation-friendly for global audiences?

Make technical writing translation-friendly by applying consistent terminology, avoiding contractions, and using present tense. These globally-friendly language rules ensure content remains accessible across international software projects.

Can I use a style guide to enforce consistent terminology across Jira issues?

Yes, you can use a style guide to enforce consistent terminology across Jira issues. The guidelines validate technical content by applying parallel lists and avoiding jargon, ensuring clarity across all project documentation.

How do I validate technical content for clarity and consistency at scale?

Validate technical content for clarity at scale by checking for active voice, short sentences, and explicit nouns. This structured review process applies to drafting, editing, and reviewing software documentation.

Does this technical writing approach work for creating CLAUDE files and prompts?

Yes, this technical writing approach works for creating CLAUDE files and prompts. It enforces clarity-focused writing rules including explicit nouns and consistent terminology, directly applicable to drafting prompt instructions.

Why does my technical documentation fail to maintain consistent terminology?

Technical documentation fails to maintain consistent terminology when structured guidelines are not applied. Enforcing active voice, present tense, and parallel lists during the editing process resolves these inconsistencies.