Add Google Developer Documentation Style skill and enforce it.

fb9af0138fd9 · AtlantisPleb · · parent d89030049d36

Add Google Developer Documentation Style skill and enforce it.

Fetches the Google style guide, creates a
`.devin/skills/google-developer-style/SKILL.md`, and adds a
Communication style section to `AGENTS.md` so all docs, commit messages,
and agent output follow the guide.

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By
Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>

Deploy story

What this commit did to the running system — joined from the forge receipt chain, the part a commit page elsewhere cannot show.

Not deployed through the forge lane

No push, promotion, build, or deploy receipt references this commit (receipts are scanned over a bounded recent window). Changes shipped by full node replacement carry their proof in the release gate receipt instead.

Changed files

  • added .devin/skills/google-developer-style/SKILL.md
  • modified AGENTS.md

Diff

2 files changed, +74 -0

.devin/skills/google-developer-style/SKILL.md added +62

@@ -0,0 +1,62 @@

1
# Google Developer Documentation Style
2
3
Use this skill when writing or reviewing user-facing documentation, READMEs, `AGENTS.md`, and commit messages for OpenAgents.
4
5
## How to invoke
6
7
Apply these rules to the text you are about to produce or edit. When a rule would make something less clear, break the rule and stay consistent.
8
9
## Voice and tone
10
11
- Be conversational and friendly, but not frivolous or overly casual.
12
- Write as a knowledgeable friend who understands what the developer wants to do.
13
- Avoid jargon, buzzwords, clichés, metaphors, ableist language, and pop-culture references.
14
- Avoid exclamation marks and over-polite phrases such as "please" or "please note."
15
- Avoid filler words like "simply," "just," "it's easy," or "quickly" in procedures.
16
- Avoid phrasing like "let's do something" or "we" for the reader; speak to the reader with "you."
17
18
## Language and grammar
19
20
- Use active voice. Make clear who performs the action.
21
- Use second person (`you`) for the reader.
22
- Use present tense.
23
- Use standard American spelling and punctuation.
24
- Put conditions before instructions, not after.
25
- Use serial commas.
26
- Do not use ampersands (&) as conjunctions in body text or headings.
27
28
## Formatting
29
30
- Use sentence case for all headings, titles, and navigation.
31
- Use code font for code, filenames, class names, method names, HTTP status codes, placeholders, and user input.
32
- Use bold for UI elements and run-in headings.
33
- Use italics sparingly, mainly when introducing or defining terms.
34
- Underline only for link text.
35
- Do not override global font styles.
36
37
## Lists
38
39
- Use numbered lists for sequences and procedures.
40
- Use bulleted lists for related but unordered items.
41
- Use description lists for related pairs of data.
42
- Keep list items parallel in structure.
43
44
## Code and links
45
46
- Put code in text in code font.
47
- Use descriptive link text. Avoid "click here" or "this page."
48
- Use unambiguous date and time formatting.
49
- Provide alt text for images.
50
51
## Banned patterns
52
53
- "Dude!" / "This is awesome!"
54
- "It's that simple" / "It's easy" / "simply"
55
- "Please" in instructions
56
- "At this time" / "please note"
57
- "Let's" as an imperative to the reader
58
- All-caps or title-case headings
59
60
## Source
61
62
- [Google Developer Documentation Style Guide](https://developers.google.com/style)
AGENTS.md modified +12

@@ -1,5 +1,17 @@

1 1
This is a web application written using the Phoenix web framework.
2 2
3
## Communication style
4
5
All text in this repo — docs, README, `AGENTS.md`, commit messages, and agent responses — follows the [Google Developer Documentation Style Guide](https://developers.google.com/style). When writing or reviewing text, invoke the `google-developer-style` skill.
6
7
- Write in active voice and address the reader as `you`.
8
- Use sentence case for all headings and titles.
9
- Use code font for code, filenames, class names, HTTP status codes, and placeholders.
10
- Use bold for UI elements.
11
- Use numbered lists for procedures and bulleted lists for unrelated items.
12
- Avoid jargon, buzzwords, metaphors, exclamation marks, and phrases like `simply` or `just`.
13
- Avoid `please` in instructions.
14
3 15
## Project guidelines
4 16
5 17
- Use `mix precommit` alias when you are done with all changes and fix any pending issues

This page updates live while a promote is in flight · changelog