technical-writing

Generate Google-style technical documentation for APIs, READMEs, code comments, and user guides.

2|Updated Dec 3, 2025
One-click install
npx skills add https://github.com/tenzir/claude-plugins --skill technical-writing-tenzir
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/tenzir/claude-plugins/tree/main/plugins/writing/skills/technical-writing
Command: npx skills add https://github.com/tenzir/claude-plugins --skill technical-writing-tenzir

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing clear, consistent, and user-friendly technical documentation is a challenging and time-consuming task. This Skill provides a comprehensive, actionable guide based on Google's developer documentation style, helping you produce high-quality content that is easy to understand and maintain.

Core Features & Use Cases

  • Google Style Guide Adherence: Follow best practices for voice, tone, grammar, and formatting, ensuring professional and consistent documentation across all projects.
  • Inclusive Language: Get guidance on avoiding jargon, filler phrases, and promoting inclusive terminology for a broader audience.
  • Structured Content: Learn how to effectively use headings, lists, procedures, and code examples for maximum clarity and readability.
  • Use Case: You need to write a new API documentation page. Instead of spending hours reviewing style guides or making subjective decisions, you can use this Skill to instantly apply consistent capitalization, formatting for code and UI elements, and ensure your language is active, clear, and inclusive.

Quick Start

Use the technical-writing skill to get guidelines on using active voice and avoiding jargon in documentation.

Frequently Asked Questions about technical-writing

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

FAQPage Schema
How do I write API documentation that follows Google's style guide?

Apply Google's developer documentation style to API docs by using active voice, clear language, consistent formatting for code elements, and inclusive terminology. This Skill provides structured guidance on capitalization, procedures, and code examples to ensure professional, accessible documentation across your project.

What's the best way to make technical documentation clear and consistent?

Technical documentation clarity requires active voice, jargon-free language, and consistent formatting. This Skill teaches audience-first writing principles, proper heading structure, list formatting, and procedure design based on Google's proven documentation practices, ensuring readers understand content on first read.

How do I avoid jargon and write more accessible technical content?

Replace specialized terms with plain language, define necessary technical concepts upfront, and use inclusive terminology for broader audiences. This Skill guides you through identifying jargon traps, removing filler phrases, and restructuring sentences for clarity while maintaining technical accuracy.

Can I apply consistent style across READMEs, API docs, and code comments?

Yes. This Skill provides unified style guidance for all documentation formats—READMEs, API references, setup guides, code comments, and architecture docs. Apply the same voice, tone, capitalization rules, and formatting principles across every artifact to maintain consistency.

What should I include in a developer handbook or user guide?

Structure guides with clear headings, step-by-step procedures, relevant code examples, and active-voice explanations. This Skill teaches how to organize content hierarchically, use lists effectively, format UI and code elements, and write procedures that developers and users can follow confidently.

Why does inclusive language matter in technical documentation?

Inclusive language broadens your audience and improves comprehension by avoiding biased or exclusionary terms. This Skill shows how to replace gendered pronouns, eliminate jargon-heavy phrasing, and use terminology that welcomes all skill levels and backgrounds into your developer community.