|
| 1 | +# Copilot instructions (content review) |
| 2 | + |
| 3 | +Use these instructions when reviewing or editing content in this repository. Keep changes minimal, preserve technical accuracy, and align with Microsoft Style Guide principles. |
| 4 | + |
| 5 | +## Core principles |
| 6 | + |
| 7 | +- **Clarity first**: Prefer simple words, short sentences, and direct structure. |
| 8 | +- **Customer-focused**: Write for the reader’s goal; remove internal or vendor-centric language. |
| 9 | +- **Actionable**: Tell readers exactly what to do and what to expect. |
| 10 | +- **Consistent**: Use consistent terminology, capitalization, and formatting throughout a doc set. |
| 11 | + |
| 12 | +## Voice, tone, and grammar |
| 13 | + |
| 14 | +- Use **second person** ("you") and **active voice** when possible. |
| 15 | +- Use **present tense** where it fits (avoid unnecessary future tense like “will”). |
| 16 | +- Avoid marketing language ("best-in-class", "easy", "simple", "seamless") unless the doc is explicitly marketing. |
| 17 | +- Use **US English** spelling and punctuation. |
| 18 | +- Prefer **sentence case** for headings unless the existing doc set uses a different convention. |
| 19 | + |
| 20 | +## Inclusive, accessible writing |
| 21 | + |
| 22 | +- Avoid biased or exclusionary terms; use inclusive alternatives. |
| 23 | +- Avoid idioms, slang, and culturally specific references. |
| 24 | +- Write descriptive link text (avoid “click here”). |
| 25 | +- Use accessible list/table structures and keep headings meaningful. |
| 26 | + |
| 27 | +## Terminology and branding |
| 28 | + |
| 29 | +- Use official product names on first mention; keep names consistent. |
| 30 | +- Expand acronyms at first use: *Azure Virtual Network (VNet)*. |
| 31 | +- Don’t invent new abbreviations. |
| 32 | +- Use consistent UI labels: match the product UI exactly when referring to buttons/menus. |
| 33 | + |
| 34 | +## Structure and formatting |
| 35 | + |
| 36 | +- Lead with the outcome or task goal, then prerequisites, then steps. |
| 37 | +- Prefer **scannable** content: |
| 38 | + - One idea per paragraph. |
| 39 | + - Use bullets for lists; keep bullets parallel. |
| 40 | + - Use numbered steps for procedures. |
| 41 | +- Avoid very long sentences (aim for ~20–25 words max when possible). |
| 42 | + |
| 43 | +## Technical accuracy and safety |
| 44 | + |
| 45 | +- Do not change the meaning of technical statements. |
| 46 | +- If something is unclear or unverifiable, **flag it** rather than guessing. |
| 47 | +- Avoid absolute guarantees ("always", "never", "fully secure"). Qualify precisely. |
| 48 | +- Keep commands and code blocks exact; don’t “correct” code unless you can validate. |
| 49 | + |
| 50 | +## Links, references, and examples |
| 51 | + |
| 52 | +- Prefer stable Microsoft Learn links when available. |
| 53 | +- Ensure links are relevant and not redundant. |
| 54 | +- Keep examples realistic and minimal. |
| 55 | +- For placeholders, use obvious placeholders (for example, `<resource-group>`), and keep them consistent. |
| 56 | + |
| 57 | +## Localization readiness |
| 58 | + |
| 59 | +- Avoid embedding text in images. |
| 60 | +- Avoid concatenating strings in a way that breaks translation. |
| 61 | +- Use consistent terminology and avoid ambiguous pronouns. |
| 62 | + |
| 63 | +## Review checklist (before you finalize) |
| 64 | + |
| 65 | +- Does the doc state **who this is for** and **what you’ll accomplish**? |
| 66 | +- Are headings and steps **task-based** and easy to scan? |
| 67 | +- Are acronyms defined on first use? |
| 68 | +- Is language inclusive and accessible? |
| 69 | +- Are UI labels, commands, and code blocks correct and consistent? |
| 70 | +- Are claims precise, not promotional, and not overconfident? |
| 71 | +- Are links descriptive and helpful? |
| 72 | + |
| 73 | +## When unsure |
| 74 | + |
| 75 | +- Ask for clarification or point out the ambiguous section. |
| 76 | +- Prefer minimal edits that improve clarity without changing intent. |
0 commit comments