Does it provide templates for different types of documents?

Yes, the skill includes specific templates for implementation reports, technical investigation reports, and progress updates.

Can this skill help with code reviews?

Yes, it provides guidance on writing courteous and clear code review comments that help maintain technical standards without being ambiguous.

What are the '7 Cs' used in this skill?

The 7 Cs are Clear, Concise, Correct, Coherent, Concrete, Complete, and Courteous. These are the core principles used to ensure technical writing is effective and professional.

How does it help improve existing documentation?

It uses an anti-pattern checklist to identify and fix common issues like redundant expressions, vague technical terms, and passive voice.

Is this skill useful for non-developers?

Absolutely. Anyone involved in technical communication, such as technical writers or project managers, can use these principles to improve document clarity.

Technical Writing Standards

Name: Technical Writing Standards
Author: sumik5

bysumik5

학습 및 문서화

Applies the '7 Cs' principles to create clear, concise, and professional technical documentation and reports.

소개

This skill optimizes Claude's ability to produce high-quality technical documentation by enforcing the '7 Cs' (Clear, Concise, Correct, Coherent, Concrete, Complete, and Courteous). It provides structured templates for reports, style guides for sentence construction, and specific checklists to avoid common anti-patterns like redundancy or ambiguity. Whether you are drafting READMEs, technical investigations, or code comments, this skill ensures your writing is professional, accurate, and perfectly tailored to your target audience's technical level.

주요 기능

Audience-aware tone and complexity adjustment for documentation
Implements '7 Cs' communication principles for technical clarity
Detailed guidance on sentence structure and active voice usage
0 GitHub stars
Comprehensive anti-pattern checklist to eliminate redundant expressions
Standardized templates for implementation and progress reports

사용 사례

Writing clear, meaningful code comments and high-quality README files
Refining technical blog posts and internal team documentation for better readability
Generating professional status reports and technical investigation documents

소개

주요 기능

Audience-aware tone and complexity adjustment for documentation
Implements '7 Cs' communication principles for technical clarity
Detailed guidance on sentence structure and active voice usage
0 GitHub stars
Comprehensive anti-pattern checklist to eliminate redundant expressions
Standardized templates for implementation and progress reports

사용 사례

Writing clear, meaningful code comments and high-quality README files
Refining technical blog posts and internal team documentation for better readability
Generating professional status reports and technical investigation documents