Skip to content

Commit 8d727f8

Browse files
committed
Update proofread skill with heading IDs and conciseness prompt
1 parent 127cad1 commit 8d727f8

2 files changed

Lines changed: 88 additions & 75 deletions

File tree

Lines changed: 42 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,57 @@
11
---
2-
name: proofread_markdown
3-
description: Proofreads markdown files that were changed in a workspace
2+
name: proofread-markdown
3+
description: Proofreads Markdown files against Google guidelines.
44
---
55

6-
# Proofread markdown files
6+
# Proofreading Markdown
77

8-
Hi there! You can use this skill to proofread markdown files. This particular
9-
project has documentation style rules that are slightly different than what you
10-
are used to, so please use the steps in this workflow to update any markdown
11-
files that have changed.
8+
## Overview
129

13-
## 1. Check line length
10+
Help us transform technical text into clear, concise,
11+
and machine-readable Markdown. We follow the
12+
Google Developer Documentation Style Guide.
1413

15-
Leadership does not want markdown files to have lines that exceed 80 characters.
16-
The reason is that it makes it easier to read for humans, and this is easier for
17-
agents, when a screenshot of a markdown file is needed.
14+
## Workflow
1815

19-
1. Run the `wrap_lines.dart` script on the file to automate line wrapping:
16+
### 1. Check line length
2017

21-
```bash
22-
dart .agents/skills/proofread_markdown/scripts/wrap_lines.dart <file_path>
23-
```
18+
- [ ] Keep lines under 80 characters.
19+
- [ ] Ask the user if they would like to use:
20+
- **Semantic line breaks**: Break lines semantically.
21+
according to the guidelines in
22+
[references/semantic_breaks.md](references/semantic_breaks.md).
23+
- **Simple line wrapping**: Wrap lines every 80 characters using
24+
[scripts/wrap_lines.dart](scripts/wrap_lines.dart).
25+
- **No line wrapping**: Do not change the line wrapping, let the user
26+
do it themselves.
27+
- [ ] Verify that the file was wrapped correctly, preserving headings and
28+
code blocks
2429

25-
2. Verify that the file was wrapped correctly (preserving headings and
26-
code blocks).
30+
### 2. Fix voice and tone
2731

32+
- [ ] Use active voice.
33+
- [ ] Use present tense.
34+
- [ ] Use second person ("you"). No "we".
2835

29-
## 2. Convert headings with title case to sentence case
36+
### 3. Check word choice
3037

31-
If you see a heading (any level) that use title case like this:
38+
- [ ] Replace forbidden terms: "e.g.", "i.e.", "etc.", "should", "would",
39+
"could".
40+
- [ ] Use Oxford comma and American spelling.
3241

33-
```
34-
## Do A Thing
35-
```
42+
### 4. Check style of headings and lists
3643

37-
Change it to look like this
44+
- [ ] Use Sentence case for headings.
45+
- If you change a heading, add an id after the heading like this:
46+
"## Configure the project {: #project-configuration }"
47+
- [ ] Put a blank line after all headings.
48+
- [ ] Numbered lists MUST use `1.` for every item to allow easy reordering.
49+
- [ ] How-to sections must have active voice in headings.
50+
- No: "## Project Configuration"
51+
- Yes: "## Configure the project"
52+
53+
### 5. Use less words in sections with steps
3854

39-
```
40-
## Do a thing
41-
```
42-
43-
## 3. Use active voice in headings
44-
45-
Let's use active voice in headings. So if you see a heading that looks like
46-
this:
47-
48-
```
49-
## Project Configuration
50-
```
51-
52-
Change it to active voice that looks like this:
53-
54-
```
55-
## Configure the project
56-
```
57-
58-
## 4. Put a blank line after headings
59-
60-
Make sure there is always a blank line after a heading. So if you see a
61-
heading that looks like this:
62-
63-
```
64-
## Configure the project
65-
Do a thing, blah blah blah.
66-
```
67-
68-
Change it to look like this:
69-
70-
```
71-
## Configure the project
72-
73-
Do a thing, blah blah blah.
74-
```
75-
76-
## 5. Use less words in sections with steps
77-
78-
If a section has steps in it, be brief. Keep it short, simple, and accurate.
79-
80-
Change steps to be direct like this:
81-
82-
```
83-
### Search for a Topic
84-
85-
1. Navigate to the **Search** tab (Magnifying Glass icon).
86-
2. Select **View topics** from the dropdown (default).
87-
3. Enter your query in the "Query" text box (e.g., "Flutter widgets").
88-
4. Press **Enter**.
89-
5. View results in the main content area.
90-
```
55+
- [ ] Ask the user if they would like the steps to be more concise.
56+
If yes, update the steps to be brief. Keep it short, simple, and
57+
accurate.
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Semantic Line Breaks
2+
3+
Semantic line breaks make Markdown files easier to read,
4+
maintain, and review in diffs.
5+
Instead of wrapping text at a strict character limit,
6+
lines are broken at natural pauses.
7+
8+
- **Max length**: Try to keep lines under 80 characters.
9+
- **Punctuation first**: Break lines after periods, commas, colons, and
10+
semicolons.
11+
- **Natural pauses**: If a line is still too long after punctuation,
12+
break at natural pauses (for example, ends of phrases).
13+
- **No mid-word breaks**: Never break a line in the middle of a word.
14+
- **Safety**: Do not break URLs, file paths, or code strings.
15+
16+
## Examples
17+
18+
### Bad: Strict 80-character wrapping
19+
20+
This approach makes diffs hard to read
21+
because changing one word reflows the entire paragraph.
22+
23+
```markdown
24+
This is a very long sentence that is wrapped at exactly eighty characters
25+
without considering the meaning of the words or the structure of the sentence.
26+
```
27+
28+
### Good: Semantic line breaks
29+
30+
This approach keeps lines readable
31+
and ensures that changes to one sentence only affect that line in the diff.
32+
33+
```markdown
34+
This is a very long sentence,
35+
that is wrapped at natural pauses
36+
to make it easier to read and maintain.
37+
```
38+
39+
Another example with list items:
40+
41+
```markdown
42+
- This is a list item,
43+
broken at the comma.
44+
- Here is another item
45+
that is broken at a natural pause.
46+
```

0 commit comments

Comments
 (0)