projectb-google-dev-docs-style

Write and edit technical documentation following the Google developer documentation style guide.

Updated May 28, 2023
One-click install
npx skills add https://github.com/steveulrich/ProjectB --skill projectb-google-dev-docs-style-steveulrich
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: projectb-google-dev-docs-style
Source: https://github.com/steveulrich/ProjectB/tree/main/.agents/skills/projectb-google-dev-docs-style
Command: npx skills add https://github.com/steveulrich/ProjectB --skill projectb-google-dev-docs-style-steveulrich

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Technical documentation often suffers from inconsistent voice, unclear procedures, ambiguous links, and accessibility issues. This Skill applies the Google developer documentation style guide so READMEs, API docs, tutorials, and reference pages stay consistent, readable, and accessible. ## Core Features & Use Cases - Style enforcement: Applies rules for voice, tone, headings, formatting, dates, code font, and word choice based on the official Google style guide. - Structured workflow: Identifies document type (concept, task, tutorial, reference, troubleshooting) and consults dedicated reference files for procedures, links, formatting, and accessibility. - Pre-publish checklist: Runs editorial checks covering voice, structure, procedures, and links before publication. - Use Case: Ask the AI to revise a README or how-to guide; it rewrites the content in second person and active voice, fixes heading case, replaces "click here" links with descriptive text, and returns a change summary. ## Quick Start Use the Google dev docs style skill to revise this README so it follows the Google developer documentation style guide.

Frequently Asked Questions about projectb-google-dev-docs-style

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

FAQPage Schema
How do I write documentation in Google developer style?▼

Identify the document type first, then apply the style rules: second person, active voice, sentence-case headings, and descriptive link text. This Skill walks through a workflow that consults reference files for voice, formatting, procedures, and links before returning revised content.

What document types does the Google style guide cover?▼

The Skill handles concept docs, task and how-to guides, tutorials, reference pages, and troubleshooting content. It also supports READMEs, API docs, and release notes, applying type-specific conventions such as bare-infinitive task headings.

Does the Google style guide require active voice everywhere?▼

Active voice is the default so the actor stays clear, but passive voice is acceptable when emphasizing the object, de-emphasizing the actor, or when the actor is irrelevant, such as "The database was purged in January."

How should links be written in developer documentation?▼

Use descriptive link text that makes sense out of context, never "click here" or raw URLs. Introduce cross-references with "For more information, see..." and explain unexpected behavior like downloads or new tabs.

What accessibility rules apply to technical docs?▼

Avoid directional language like "above" or "below"; use "preceding" and "following" instead. Provide alt text on images, never skip heading levels, keep sentences under roughly 26 words, and refer to UI elements by their visible labels.

When can Google style rules be broken?▼

The rules are guidelines, not laws. Project-specific style overrides take priority, and a rule may be broken when doing so improves clarity for the audience, as long as usage stays consistent within the document.