When does the technical-writer skill activate?

It activates automatically when you work with .md files in docs/ directories, edit README files, or discuss documentation structure, style guides, and content organization.

Does this skill follow specific style guides?

Yes, it applies industry-standard principles such as active voice, sentence case for titles, and specific formatting conventions for UI elements and code blocks.

Can it generate API documentation?

Yes, it uses standardized patterns to create detailed API references including parameter tables, return values, and clear, functional code examples.

How does it ensure documentation quality?

The skill follows a multi-phase approach including audience analysis, content type selection, and automated validation scripts to check for broken links and heading hierarchy.

Technical Writing Expert

Name: Technical Writing Expert
Author: sjungling

bysjungling

•

学習とドキュメンテーション

Generates professional-grade technical documentation including READMEs, API references, and tutorials using structured content models and industry best practices.

The Technical Writing Expert skill transforms Claude into a specialized documentation specialist capable of producing clear, accessible, and actionable technical content. It automatically activates when working with markdown files, READMEs, or documentation directories to ensure your project's guides, API references, and release notes follow professional standards. By applying structured information architecture and consistent style guide principles, it helps developers communicate complex technical concepts effectively to both beginners and advanced users.

主な機能

01Structured content modeling for conceptual, referential, and procedural articles

02Task-oriented procedural writing with optimized step structures

03Automated markdown validation for heading hierarchy, link syntax, and code blocks

04Standardized API documentation templates with parameter tables and examples

055 GitHub stars

06Style guide enforcement for active voice, technical formatting, and accessibility

ユースケース

01Creating end-to-end tutorials and 5-minute quickstart guides for users

02Generating comprehensive project READMEs from source code analysis

03Drafting technical specifications and detailed API reference documentation

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add sjungling/claude-plugins technical-writer

For use in Claude.ai and ChatGPT

Download Skill