google-dev-docs

Solid

Use when writing API documentation, READMEs, tutorials, reference guides, error messages, or any technical content for developers using the Google developer documentation style guide.

AI & Automation 33 stars 1 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
51
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Google Developer Documentation Style Write precise, task-oriented technical documentation with second-person address and active voice. ## The core rule **Task-oriented headings, present tense, second person ("you"), active voice.** Workflow: `state user goal in title` → `prerequisites first` → `numbered steps with concrete code examples` → `verification step`. ## Mechanics 1. **Second person.** Address the developer directly as "you"; avoid "we", "us", or third-person generalities. 2. **Present tense.** Describe current system behavior in present tense ("Returns a 200 OK status", not "Will return"). 3. **Task-oriented headings.** Start headings with gerunds or action verbs ("Configuring authentication", not "Authentication overview"). 4. **Active voice.** "The server processes the request" rather than "The request is processed by the server". 5. **Code blocks with context.** Every code snippet must include necessary imports, setup, and expected output. 6. **Pronoun clarity.** Ensure "this", "that", and "it" clearly point to a preceding noun. 7. **Consistent terminology.** Use identical terms across guides, API references, and UI labels. 8. **Concise error messages.** Explain what went wrong and how to fix it immediately. ## Verify - Headings use gerunds or action verbs describing tasks - Sentences consistently use second person ("you") - Code snippets are complete, syntactically valid, and tested - Active voice used throughout instructions - Present tense used for A...

Details

Author
surendranb
Repository
surendranb/writing-skills
Created
4 weeks ago
Last Updated
1 weeks ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category