- name
- proofread-markdown
- description
- Proofreads Markdown files against Google guidelines.
# Proofreading Markdown
## Overview
Help us transform technical text into clear, concise,
and machine-readable Markdown.
We follow the Google Developer Documentation Style Guide.
## Workflow
### 1. Check line length
- [ ] Keep lines under 80 characters.
- [ ] Use **semantic line breaks**: Follow the guidelines in
[references/semantic_breaks.md](references/semantic_breaks.md).
### 2. Fix voice and tone
- [ ] Use active voice.
- [ ] Use present tense.
- [ ] Use second person ("you"). No "we".
- [ ] Use contractions.
### 3. Check word choice
- [ ] No forbidden terms: "e.g.", "i.e.", "etc.", "should", "would", "could".
- [ ] Use Oxford comma and American spelling.
### 4. Style headings and lists
- [ ] Use Sentence case for headings.
- [ ] Put a blank line after all headings.
- [ ] Numbered lists MUST use `1.` for every item to allow easy reordering.
### 5. Use less words in sections with steps
- [ ] If a section has steps in it, be brief. Keep it short, simple, and accurate.
### 6. Format links
- [ ] Use link definitions (reference-style links) instead of inline links.
- [ ] Use site-relative paths (for example, `/resources/whats-new`)
instead of full absolute URLs (for example,
`https://dart.dev/resources/whats-new`) for internal site links.
GitHubで見る