google-style-audit

Audit changed text in code and docs against the Google developer documentation style guide.

Updated Apr 3, 2021
One-click install
npx skills add https://github.com/shrik450/dotfiles --skill google-style-audit-shrik450
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: google-style-audit
Source: https://github.com/shrik450/dotfiles/tree/main/dot_claude/skills/google-style-audit
Command: npx skills add https://github.com/shrik450/dotfiles --skill google-style-audit-shrik450

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Reviewing pull requests and change sets for writing style violations is slow and inconsistent, especially when prose hides in code comments, error messages, UI labels, and test strings. This Skill audits every changed text surface against the Google developer documentation style guide and produces a structured findings report. ## Core Features & Use Cases - Full text-surface coverage: Audits docs, UI copy, errors, logs, comments, prompts, configuration descriptions, test strings, and terminology in identifiers, not just Markdown files. - Flexible scope resolution: Accepts a pull request, branch, commit range, patch, working tree, or named files, and resolves ambiguity before auditing. - Rule-grounded findings: Cites each finding with path and line, the exact current text, a suggested replacement, and the specific guide rule with a URL. - Use Case: Before merging a pull request that touches README files, CLI help text, and error messages, run the audit to catch non-inclusive terms, passive voice, and capitalization issues with concrete suggested fixes. ## Quick Start Audit the current working tree changes against the Google developer documentation style guide and report any style findings.

Frequently Asked Questions about google-style-audit

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

FAQPage Schema
How do I audit a pull request against the Google developer documentation style guide?

Pass the pull request number or URL as the argument. The audit uses gh pr view and gh pr diff to gather the change set, then checks every changed text surface against the style rules and reports findings with path and line citations.

What text surfaces does a documentation style audit cover?

The audit covers Markdown, UI labels, error messages, logs, CLI help, code comments, docstrings, prompts, configuration descriptions, test expectations, and human-readable words in identifiers. It skips binary content, lockfiles, and machine-generated data.

Can I audit only uncommitted working tree changes for style issues?

Yes. Run the audit with no argument or with working-tree to inspect staged, unstaged, and untracked changes. It combines git diff, git diff --cached, and git ls-files --others --exclude-standard so no changed text is missed.

Does the style audit edit files or post review comments?

No. The audit only reports findings and never edits files, posts comments, stages changes, or commits. Each finding includes the current text, a suggested replacement, the rule, and a reason so you can apply fixes yourself.

How does the audit handle fixed API names and code identifiers?

It preserves exact product names, API names, commands, protocol terms, and quoted third-party text. For identifiers it applies only terminology, inclusion, capitalization, and spelling rules, never prose punctuation rules.