|
1 | 1 | --- |
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. |
4 | 4 | --- |
5 | 5 |
|
6 | | -# Proofread markdown files |
| 6 | +# Proofreading Markdown |
7 | 7 |
|
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 |
12 | 9 |
|
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. |
14 | 13 |
|
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 |
18 | 15 |
|
19 | | -1. Run the `wrap_lines.dart` script on the file to automate line wrapping: |
| 16 | +### 1. Check line length |
20 | 17 |
|
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 |
24 | 29 |
|
25 | | -2. Verify that the file was wrapped correctly (preserving headings and |
26 | | - code blocks). |
| 30 | +### 2. Fix voice and tone |
27 | 31 |
|
| 32 | +- [ ] Use active voice. |
| 33 | +- [ ] Use present tense. |
| 34 | +- [ ] Use second person ("you"). No "we". |
28 | 35 |
|
29 | | -## 2. Convert headings with title case to sentence case |
| 36 | +### 3. Check word choice |
30 | 37 |
|
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. |
32 | 41 |
|
33 | | -``` |
34 | | -## Do A Thing |
35 | | -``` |
| 42 | +### 4. Check style of headings and lists |
36 | 43 |
|
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 |
38 | 54 |
|
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. |
0 commit comments