Skip to content

Commit 3b8f7ef

Browse files
Refine word choice and style guidelines for clarity and consistency; streamline common phrases and avoid condescending language.
1 parent d0885d7 commit 3b8f7ef

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

.github/copilot-instructions.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,8 @@ Voice and Tone:
131131
### Word choice and style
132132
- Use these preferred terms and phrases for consistency:
133133
- Numbers and units: Spell out numbers one through five (one, two, three, four, five), after this use numerals (6, 7, 8...). Use proper spacing for units: "1 GB", "23 MB/day" (not "1GB", "23MB/day"). Use "K" for thousands: "64K" (not "64k"). Use abbreviations for data rates: "Gbps" (not "Gb per second").
134-
- Technical terms: "adapter" (not "adaptor"), "AI" (not "artificial intelligence" in most contexts), "backend" and "frontend" (not "back-end", "front-end"), "cloud native" (not "Cloud Native"), "serverless" (not "server-less"), "touchscreen" (not "touch screen"), "suboptimal" (not "sub-optimal"), "ITaaS" (not "ITAAS"), "license" (not "licence"), "analyze" (not "analyse").
135-
- Common phrases: "To [action]" (not "Follow the steps below to [action]"), "for example" (not "e.g."), "that is" (not "i.e."), "because" (not "since"), "also" (not "in addition"), "to" (not "in order to"), "see" (not "refer to"), "use" (not "utilize" or "leverage"), "need" (not "require"), "can" or "might" (not "may"), "affect performance" (not "impact performance"), "remove" (not "eliminate", "extract", or "take away"), "set up" as verb, "setup" as noun, "turn on/off" (not "power on/off"), "copy" (not "rip"), "identify" (not "spot"), "therefore" (not "ergo"), "namely" (not "viz."), "avoid" (not "try not to").
136-
- Avoid condescending language: Don't use "simply", "just", "obviously", "clearly" - what's simple to you might not be to the learner, and these words can make people feel stupid when they struggle.
134+
- Common phrases: "To [action]" (not "Follow the steps below to [action]"), "for example" (not "e.g."), "that is" (not "i.e."), "because" (not "since"), "also" (not "in addition"), "to" (not "in order to"), "see" (not "refer to"), "use" (not "utilize" or "leverage"), "need" (not "require"), "can" or "might" (not "may"), "set up" as verb, "setup" as noun, "therefore" (not "ergo"), "namely" (not "viz."), "avoid" (not "try not to").
135+
- Avoid condescending language: Don't use "simply", "just", "obviously", "clearly" - what's simple to you might not be to the learner.
137136
- Acknowledge when something can be tricky: Use phrases like "this step can be confusing at first" to validate learner experience.
138137
- Normalize errors: Use phrases like "if you see this error, here's how to fix it" to reassure learners that errors are part of the learning process.
139138
- User interface terms: "select" or "tap" (not "click" for mobile/touch interfaces), "keyboard shortcut" (not "key combination"), "Ctrl key" (capitalized), "double-tap" (not "double-click" for touch interfaces).

0 commit comments

Comments
 (0)