google-dev-docs — скилл для Claude Code: документация по гайду Google
Скилл задаёт агенту стиль Google для техдокументации: заголовки-действия, обращение на «вы», настоящее время, активный залог. Пригодится, когда пишете README, туториал или справку по API.
npx skills add surendranb/writing-skills --skill google-dev-docs -a claude-codeЧто делает google-dev-docs
Скилл — это набор правил в SKILL.md, который агент подхватывает, когда просите писать документацию для разработчиков: README, туториалы, справочники, сообщения об ошибках. Он требует стандартный Markdown-парсер и контекст агента, больше ничего не нужно.
Внутри — восемь механических правил. Заголовки начинаются с отглагольного существительного или глагола действия, каждый сниппет идёт с импортами, настройкой и ожидаемым выводом, местоимения «this» и «it» должны указывать на конкретный предмет. Термины повторяются одинаково по всем гайдам.
Структура текста: цель пользователя в заголовке, потом предварительные требования, нумерованные шаги с кодом и проверка в конце. В references/REFERENCE.md лежат точные правила про числа, проценты, диапазоны и единицы — скилл подгружает их, только если в черновике такие места встретились. Есть и примеры переделки фраз: размытое «in order to» превращается в короткое «To».
Какие задачи решает
- переписать README в стиле Google для разработчиков
- собрать туториал с шагами и проверкой результата
- привести справку по API к настоящему времени и активному залогу
- переписать сообщение об ошибке так, чтобы сразу было видно, как исправить
- вычистить из черновика «Simply run» и «Just configure»
Примеры запросов агенту
- Напиши README для библиотеки
client.pyпо стилю Google: заголовки-действия, обращение на «вы», настоящий время - Отредактируй туториал в
docs/setup.md: убери будущее время и добавь к каждому сниппету импорты и ожидаемый вывод - Перепиши сообщения об ошибках в
errors.md: что сломалось и как это исправить
Как установить google-dev-docs
1Через Skills CLI (Vercel)
npx skills add surendranb/writing-skills --skill google-dev-docs -a claude-code2Вручную: положить файлы
~/.claude/skills/google-dev-docs/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/google-dev-docs/
1Через Skills CLI (Vercel)
npx skills add surendranb/writing-skills --skill google-dev-docs -a codex2Вручную: положить файлы
.agents/skills/google-dev-docs/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add surendranb/writing-skills --skill google-dev-docs -a cursor2Вручную: положить файлы
.cursor/skills/google-dev-docs/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install surendranb/writing-skills google-dev-docs2Вручную: положить файлы
.github/skills/google-dev-docs/SKILL.md1Через Skills CLI (Vercel)
npx skills add surendranb/writing-skills --skill google-dev-docs -a gemini-cli2Командой платформы
gemini skills install https://github.com/surendranb/writing-skills --path skills/google-dev-docsВручную: положить файлы
.devin/skills/google-dev-docs/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add surendranb/writing-skills --skill google-dev-docs -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о google-dev-docs
Как установить google-dev-docs в Claude Code?
Выполните npx skills add surendranb/writing-skills --skill google-dev-docs -a claude-code. Файл скилла окажется по пути ~/.claude/skills/google-dev-docs/SKILL.md.
Что делает google-dev-docs?
Задаёт агенту стиль Google для техдокументации: заголовки по задачам, второе лицо, настоящее время, активный залог и полные примеры кода с импортами.
Нужно ли читать references/REFERENCE.md заранее?
Нет. Скилл загружает его по требованию, когда в черновике попадаются числа, проценты, диапазоны, сокращения или единицы измерения.
Исходный текст
SKILL.md · MIT
---
name: google-dev-docs
description: Use when writing API documentation, READMEs, tutorials, reference guides, error messages, or any technical content for developers using the Google developer documentation style guide.
compatibility: Requires standard Markdown parser and agent context
---
# 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 API descriptions
## Do not
- Use future tense for deterministic software behavior ("The method will return...")
- Leave code snippets without imports or setup context
- Use vague filler phrases ("Simply run...", "Just configure...")
- Mix second person and first person within the same tutorial
## References
For exact mechanical rules (numbers, percentages, ordinals, ranges, abbreviations, units), read `references/REFERENCE.md` when a draft contains any of these — load on demand, not upfront.
## Example transformations
**Before:** "In order to initialize our SDK, users are required to first invoke the setup method, after which time you will be able to make API requests successfully."
**After:** "To initialize the SDK, call `setup()`. Once initialized, you can make API requests."
**Before:** "Simply add the configuration dictionary to your project and you're good to go!"
**After:** "Add the configuration dictionary to your project configuration file."
© surendranb · MIT · surendranb/writing-skills