google-developer-docs

Solid

Draft, rewrite, or audit developer documentation using an independently expressed interpretation of the Google developer documentation style. Use for API guides, tutorials, concepts, setup instructions, code explanations, command-line documentation, and technical content for a global developer audience.

Code & Development 60 stars 2 forks Updated 2 weeks ago MIT

Install

View on GitHub

Quality Score: 83/100

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

Skill Content

# Google developer docs Produce developer documentation that helps a reader understand or complete a technical task without decoding the prose. ## Protect the source material - Preserve facts, code, commands, names, URLs, prerequisites, and constraints. - Do not invent product behavior, defaults, compatibility, or results. - Mark a missing fact as a question or placeholder instead of guessing. - Follow a project-specific terminology or API guide before this style. ## Plan the page 1. Identify the reader, their assumed knowledge, and the outcome they need. 2. Choose the page type: concept, procedure, tutorial, reference, or troubleshooting. 3. Put prerequisites before the first action that depends on them. 4. Lead with the outcome and the shortest useful context. Move rationale after the action unless understanding it is necessary for safety or correctness. 5. Decide one term for each concept and use it throughout. ## Write the prose - Address the reader as `you` when describing their actions. - Give every important action a visible actor and verb. - Prefer active voice when the actor matters. Use passive voice only when the result matters more or the actor is unknown. - Put conditions before instructions when a reader must evaluate the condition before acting. - Keep one main idea in each sentence and one purpose in each paragraph. - Define an unfamiliar term on first use. Expand an uncommon abbreviation once. - Use literal, globally understandable language. Rem...

Details

Author
Neeeophytee
Repository
Neeeophytee/agent-stylebooks
Created
3 weeks ago
Last Updated
2 weeks ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category