google-developer-style

Applies Google developer documentation style rules to comments, docs, and user-facing prose.

2|Updated Jun 27, 2026
One-click install
npx skills add https://github.com/imjasonh/playground --skill google-developer-style-imjasonh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: google-developer-style
Source: https://github.com/imjasonh/playground/tree/main/.cursor/skills/google-developer-style
Command: npx skills add https://github.com/imjasonh/playground --skill google-developer-style-imjasonh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Inconsistent tone, grammar, and terminology across code comments, READMEs, API docs, and PR descriptions make a repository harder to read and maintain. This Skill gives the AI a concrete, working subset of the Google developer documentation style guide so every piece of prose it writes or edits follows the same rules. ## Core Features & Use Cases - Style rules for prose: Enforces active voice, present tense, second person, sentence-case headings, serial commas, and condition-before-instruction phrasing. - Artifact-specific guidance: Adapts person and shape for Markdown docs, HTML help text, godoc/rustdoc/JSDoc/Swift API comments, inline comments, and PR descriptions. - Word list and examples: Ships reference files with preferred term replacements (for example, allowlist instead of whitelist) and before-and-after rewrites for docs and comments. - Use Case: While drafting a Go doc comment or revising a README section, the AI applies these rules automatically, replacing filler words like "just" and "simply" and rewriting passive constructions. ## Quick Start Ask the AI to review or rewrite a README section, code comment, or PR description using the Google developer documentation style guide.

Frequently Asked Questions about google-developer-style

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

FAQPage Schema
How do I apply Google documentation style to code comments?▼

Follow the language's first-sentence convention, such as starting Go godoc with the symbol name, then apply active voice, present tense, and precise word choice to the rest. Describe observable behavior, preconditions, defaults, and error cases rather than narrating the code.

What writing style should I use for README and API docs?▼

Use second person and imperative mood for procedures, sentence-case headings, and task-oriented titles. Address the reader as "you", avoid filler words like "just" and "simply", and put conditions before instructions.

Does this style guide work with Go, Rust, and JavaScript doc comments?▼

Yes. The guidance covers godoc, rustdoc, JSDoc, and Swift doc comments. Each language keeps its own comment form, while the style rules govern word choice, tone, and grammar in the body of the comment.

What words should I avoid in technical documentation?▼

Avoid filler terms like "just", "simply", and "please", directional language like "above" and "below", and non-inclusive terms like "master/slave" or "sanity check". The included word list maps each avoided term to a preferred replacement.

When should I not rewrite existing documentation for style?▼

Do not rewrite existing comments or docs unless you are already editing that prose or the user explicitly asked for a style pass. The guidelines prioritize clarity over rigid adherence and are not meant for mechanical find-and-replace.