google-documentation-guide

Applies Google's documentation philosophy and Markdown style rules to writing and reviewing technical docs.

Updated Aug 22, 2026
One-click install
npx skills add https://github.com/chughtapan/google-guide-skills --skill google-documentation-guide-chughtapan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: google-documentation-guide
Source: https://github.com/chughtapan/google-guide-skills/tree/main/skills/google-documentation-guide
Command: npx skills add https://github.com/chughtapan/google-guide-skills --skill google-documentation-guide-chughtapan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Technical documentation often becomes stale, inconsistent, or bloated because teams lack shared standards for writing, formatting, and maintaining it. This Skill encodes Google's documentation philosophy, best practices, and Markdown style guide so agents can write and review docs that stay accurate and readable. ## Core Features & Use Cases - Documentation best practices: Enforces minimum viable documentation, updating docs in the same change as code, deleting dead docs, and structuring the documentation story from inline comments through READMEs and design docs. - Markdown style rules: Applies concrete formatting standards including 80-character line limits, single H1 headings, fenced code blocks with declared languages, informative link titles, reference link placement, and table usage guidance. - README guidance: Defines where README.md files belong and the minimum content every package-level README must include. - Use Case: When drafting a new README for a library or reviewing a documentation pull request, activate this Skill to check structure, heading hierarchy, link style, and freshness against Google's published guidance. ## Quick Start Use the google-documentation-guide skill to review this README.md and suggest improvements based on Google's documentation style guide.

Frequently Asked Questions about google-documentation-guide

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

FAQPage Schema
How do I write a good README.md for a code package?

Place README.md in the top-level directory of the codebase, not inside a docs folder. Include what the package does, points of contact, deprecation status, usage examples such as copyable commands, and links to detailed documentation.

What Markdown style rules does Google's documentation guide enforce?

Key rules include an 80-character line limit, a single H1 heading per document, fenced code blocks with declared languages, 4-space nested list indentation, informative link titles instead of 'here', and strong preference for Markdown over HTML.

When should documentation be updated relative to code changes?

Documentation should change in the same commit or CL as the code change. This keeps docs fresh and gives reviewers context, and reviewers should insist that docstrings, headers, and READMEs update alongside code.

Should I use relative or absolute paths for Markdown links?

Use explicit paths for links within Markdown, and relative paths only for files in the same directory. Avoid relative links that traverse directories with ../ since they break easily when files move.

When should I delete documentation instead of updating it?

Delete docs that are certainly wrong or dead, since stale docs misinform and slow teams down. Start by removing what is clearly incorrect, involve the whole team in keep-or-delete decisions, and iterate gradually.