Can I use this for API documentation?

Yes, it is specifically designed for API documentation, README files, user guides, and even inline code comments.

How does it improve my technical writing?

It enforces the use of active voice, second-person perspective, and consistent formatting for UI elements and code, making your docs more professional.

What style guide does this skill follow?

This skill primarily follows the Google Developer Documentation Style Guide, prioritizing clarity, consistency, and an audience-first approach.

Does it support inclusive language?

Absolutely. It identifies and replaces non-inclusive terms like 'blacklist' or 'master/slave' with modern alternatives like 'denylist' and 'primary/replica'.

Technical Writing Guide

Name: Technical Writing Guide
Author: tenzir

bytenzir

•

学习与文档

Generates clear, professional technical documentation following the Google Developer Documentation Style Guide.

This skill empowers Claude to act as a professional technical writer, ensuring all documentation—from READMEs and API references to code comments and user guides—adheres to the industry-standard Google style guide. It prioritizes clarity, consistency, and inclusive language while providing specific instructions on voice, tone, formatting, and procedure structuring to make technical content accessible and helpful for developers of all proficiency levels.

主要功能

01Optimized heading hierarchies and list structures for readability

02Enforcement of active voice and second-person perspective for clarity

03Strict adherence to Google Developer Documentation Style Guide standards

04Standardized formatting for code snippets, UI elements, and procedures

053 GitHub stars

06Automated suggestions for inclusive language and professional terminology

使用场景

01Creating step-by-step technical tutorials and configuration procedures

02Drafting comprehensive API documentation and descriptive code comments

03Writing and refactoring project README files and user manuals

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tenzir/claude-plugins technical-writing

For use in Claude.ai and ChatGPT

Download Skill