You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Read through the article once, noting barriers to readability.
21
+
* Note barriers to scannability.
22
+
* Note content with the weakest plain language usage.
23
+
* Make changes according to the guidelines below.
24
+
* Only analyze and edit the specific .md files provided.
25
+
* Do not move or delete files, but you may suggest splitting or renaming if it improves the docs.
26
+
* Make edits only when they provide meaningful improvements. Do not revise purely for minor aesthetics.
27
+
* After making edits, review each change to verify the original meaning is preserved. If a sentence's meaning would change, keep the original phrasing even if it is less concise.
28
+
* Do not remove sentences about defaults, feature scope, or access unless clearly repeated.
## Editing Guidelines and Plain Language Principles
32
33
33
34
### Writing Style
34
35
35
-
- Use concise, everyday language. Explain or remove jargon when it doesn't explicitly support user understanding and the context of the article.
36
-
- When two possible phrasings are equally clear, choose the one with fewer words. Brevity directly improves readability.
37
-
- Use full terms and not their shortened versions.
38
-
- Use active voice and personal pronouns ("you," "your"); favor present tense.
39
-
- When “you can” introduces an instruction and does not convey optionality or permission, replace it with an active verb. For example, “You can enable” becomes “Enable”. Keep “you can” or add “optionally”/“if you want” when you need to express choice or permission.
40
-
- Retain essential technical details, such as defaults, warnings, and admin options.
41
-
- Do not alter the intent of verbs and actions (ex. "navigate" does not necessarily mean "select").
42
-
- Start at least half of steps or instructions with a direct verb, unless another structure improves clarity.
43
-
- Use sentence case for headings and list items (capitalize only the first word and proper nouns).
44
-
- Match names of buttons, menus, and UI elements exactly as they appear in the original documentation. Do not paraphrase.
36
+
* Use concise, everyday language. Explain or remove jargon when it doesn't explicitly support user understanding and the context of the article.
37
+
* When two possible phrasings are equally clear, choose the one with fewer words. Brevity directly improves readability.
38
+
* Use full terms and not their shortened versions.
39
+
* Use active voice and personal pronouns ("you," "your"); favor present tense.
40
+
* When "you can" introduces an instruction and does not convey optionality or permission, replace it with an active verb. For example, "You can enable" becomes "Enable". Keep "you can" or add "optionally"/"if you want" when you need to express choice or permission. When in doubt about whether "you can" conveys optionality, keep it.
41
+
* Retain essential technical details, such as defaults, warnings, and admin options.
42
+
* Do not alter the intent of verbs and actions (ex. "navigate" does not necessarily mean "select").
43
+
* Never change the fundamental meaning of a sentence. Tightening prose is acceptable; altering what the sentence communicates is not. Specifically:
44
+
* Do not remove qualifiers like "we recommend," "we strongly recommend," or "it's best to" — these convey the strength of guidance.
45
+
* Do not remove connective phrases like "To do this," "The following," or "For more information" that orient the reader.
46
+
* Do not convert a description of capability ("Copilot can load tools when relevant") into a statement of fact ("Copilot loads tools when relevant").
47
+
* Do not change referential phrases like "the following" to "these" when "the following" points forward to a specific list or table.
48
+
* Start at least half of steps or instructions with a direct verb, unless another structure improves clarity.
49
+
* Use sentence case for headings and list items (capitalize only the first word and proper nouns).
50
+
* Match names of buttons, menus, and UI elements exactly as they appear in the original documentation. Do not paraphrase.
45
51
46
52
### Structure
47
53
48
-
- Don’t append new information or expository text to existing content.
49
-
- Structure logically with clear, descriptive headings, short sections, and organized (bulleted or numbered) lists.
50
-
- Do not create new headers if they would only have one sentence worth of content.
51
-
- End every list item with a period if it is a complete sentence; omit periods for list fragments or single-word items.
54
+
* Don't append new information or expository text to existing content. Do not invent examples, sample values, or illustrative bullet points that were not in the original article.
55
+
* Structure logically with clear, descriptive headings, short sections, and organized (bulleted or numbered) lists.
56
+
* Do not create new headers if they would only have one sentence worth of content.
57
+
* End every list item with a period if it is a complete sentence; omit periods for list fragments or single-word items.
52
58
53
59
### Paragraphs
54
60
55
-
- State the topic at the start of each paragraph; clarify connections between paragraphs.
56
-
- Limit paragraphs to 150 words or fewer.
57
-
- Split a paragraph or list item when it includes two topics or steps.
61
+
* State the topic at the start of each paragraph; clarify connections between paragraphs.
62
+
* Limit paragraphs to 150 words or fewer.
63
+
* Split a paragraph or list item when it includes two topics or steps.
58
64
59
65
### Sentences
60
66
61
-
- Write one idea per sentence; avoid redundancy, vague modifiers, and ambiguous phrasing.
62
-
- Avoid consecutive sentences starting the same way.
63
-
- Make sure no more than 25% of sentences contain more than 20 words.
64
-
- Split sentences that contain multiple clauses into separate sentences.
67
+
* Write one idea per sentence; avoid redundancy, vague modifiers, and ambiguous phrasing.
68
+
* Avoid consecutive sentences starting the same way.
69
+
* Make sure no more than 25% of sentences contain more than 20 words.
70
+
* Split sentences that contain multiple clauses into separate sentences.
65
71
66
72
## References
67
73
68
74
These PRs demonstrate successful improvement in readability:
0 commit comments