When does the Technical Writer skill activate?

It automatically triggers when you create or edit .md files in docs/ directories, modify README files, or discuss documentation structure and style guides.

Can I use this skill for marketing or creative copy?

No, this skill is specifically designed for technical communication. It excludes marketing copy, creative writing, and academic papers to focus on clear, actionable technical content.

How does it handle documentation structure?

It follows a standardized information architecture, ordering content from conceptual and referential to procedural and troubleshooting, with a maximum of four navigation levels.

Does it follow a specific style guide?

The skill applies general industry best practices (active voice, sentence case, clear procedures) and can reference local style guide files for specific formatting rules.

Does it support API documentation?

Yes, it excels at creating referential content, including detailed API documentation with parameter tables, syntax guides, and code examples.

Technical Documentation Expert

Name: Technical Documentation Expert
Author: sjungling

bysjungling

•

コンテンツ管理

Standardizes and optimizes technical documentation including READMEs, API references, and user guides using industry best practices.

The Technical Writer skill transforms Claude into a specialized documentation engineer, providing domain-specific guidance for creating clear, accessible, and structured content. It automatically activates when working within docs directories or editing README files, ensuring that your project documentation follows professional patterns for conceptual, referential, and procedural writing. By enforcing a consistent style guide and focusing on user goals, this skill helps developers produce high-quality documentation that is easy to navigate and maintain.

主な機能

01Built-in quality assurance to prevent common documentation anti-patterns and jargon

02Enforcement of industry-standard style guides for active voice and technical formatting

038 GitHub stars

04Automated activation for Markdown files in docs/ directories and project READMEs

05Support for structured content models including API references, tutorials, and troubleshooting

06Intelligent information architecture with hierarchical navigation optimization

ユースケース

01Creating step-by-step procedural tutorials from complex codebase workflows

02Generating comprehensive API documentation with parameter tables and working examples

03Refining project READMEs to improve onboarding and community contribution clarity

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add sjungling/sjungling-claude-plugins technical-writer

For use in Claude.ai and ChatGPT

Download Skill