|
| 1 | +# Copilot Instructions |
| 2 | + |
| 3 | +This file provides central guidance for GitHub Copilot in this repository. |
| 4 | + |
| 5 | +This documentation repository contains Microsoft's technical documentation for application development using Microsoft Azure AI Foundry (and other products) that publishes to Microsoft Learn. |
| 6 | + |
| 7 | + |
| 8 | +## Referenced Instruction Files |
| 9 | + |
| 10 | +• .github/instructions/foundry-branding.instructions.md |
| 11 | +• .github/instructions/dev-focused.instructions.md |
| 12 | + |
| 13 | +## Disclosure |
| 14 | + |
| 15 | +For any Markdown files modified by AI, always disclose that they were created with the assistance of AI. Add the following frontmatter key/value pair: |
| 16 | + |
| 17 | +ai-usage: ai-assisted |
| 18 | + |
| 19 | +## Content Verification Rules |
| 20 | + |
| 21 | +- DO NOT invent or fabricate technical details, API parameters, or service capabilities. |
| 22 | +- DO NOT create fictional code examples or imaginary features. |
| 23 | +- DO NOT hallucinate or assume facts not found in official or credible documentation. |
| 24 | +- ALWAYS check specification documents and official references before making suggestions. |
| 25 | +- When a recommendation is based on another instruction file or linked source, cite it inline (for example: “(Source: edit_instructions.md)”). |
| 26 | +- If required information is missing or unclear, insert a placeholder with `[TO VERIFY]`—do not guess. |
| 27 | + |
| 28 | +## Writing Style |
| 29 | + |
| 30 | +Follow Microsoft Writing Style Guide (https://learn.microsoft.com/en-us/style-guide/welcome/) with these specifics: |
| 31 | + |
| 32 | +### Voice and Tone |
| 33 | + |
| 34 | +• Active voice, second person addressing reader directly. |
| 35 | +• Conversational tone with contractions. |
| 36 | +• Present tense for instructions/descriptions. |
| 37 | +• Imperative mood for instructions ("Call the method" not "You should call the method"). |
| 38 | +• Use "might" instead of "may" for possibility. |
| 39 | +• Use "can" instead of "may" for permissible actions. |
| 40 | +• Avoid "we"/"our" referring to documentation authors or product teams. |
| 41 | + |
| 42 | +### Pattern compliance |
| 43 | + |
| 44 | +- Articles should comply with the pattern for the ms.topic type listed in the metadata |
| 45 | + - `how-to-guide` - refer to .github/patterns/How-to-template.md |
| 46 | + - `quickstart` - refer to .github/patterns/Quickstart-template.md |
| 47 | + - `tutorial` - refer to .github/patterns/Tutorial-template.md |
| 48 | + |
| 49 | +Instructions for the pattern are contained in comments in the referenced file. |
| 50 | + |
| 51 | +## Structure and Format |
| 52 | + |
| 53 | +- Use sentence case for titles and headings; avoid gerunds in titles. |
| 54 | +- Keep paragraphs short (1–3 sentences). |
| 55 | +- Break up or rewrite long sentences (>25 words). |
| 56 | +- Use the Oxford comma in lists. |
| 57 | +- Number ordered list items using `1.` for each line (Markdown auto-numbers). |
| 58 | +- List items should be complete sentences when longer than a short phrase; end with a period if a sentence. |
| 59 | +- Avoid “etc.” or “and so on.” Use “for example” with a concrete subset or provide the full list. |
| 60 | +- Use “for example” instead of “e.g.”; “that is” instead of “i.e.”. |
| 61 | +- Don’t stack headings without intervening explanatory text. |
| 62 | +- Keep conceptual explanation separate from procedural steps. |
| 63 | +- Reserve troubleshooting for a clearly labeled section when needed. |
| 64 | + |
| 65 | +## Formatting Conventions |
| 66 | + |
| 67 | +- Bold: UI labels and visible button or menu text. |
| 68 | +- Code style (backticks): file names, folders, inline code, commands, class and method names, non-localizable tokens. |
| 69 | +- Use relative links for repo-local files. |
| 70 | +- Use angle brackets around raw URLs only when the plain URL must be shown. |
| 71 | +- Present tense only; rewrite future tense (“will create”) to present (“creates” / “creates a resource”). |
| 72 | +- Prefer gender-neutral language; avoid idioms and metaphors. |
| 73 | +- Tables only when they improve scan-ability (parameters, comparisons). |
| 74 | + |
| 75 | +## File Naming |
| 76 | + |
| 77 | +- New Markdown files: lowercase, hyphen-separated. |
| 78 | +- Omit filler words (the, a, an, of) unless needed for clarity. |
| 79 | +- Keep names task- or concept-focused (for example: `monitor-model-performance.md`). |
| 80 | + |
| 81 | + |
| 82 | +## Referencing sources |
| 83 | + |
| 84 | +When basing content on: |
| 85 | +- Internal instruction files: cite the filename inline. |
| 86 | +- External docs (public): use a relative or official Microsoft Learn link. |
| 87 | +If uncertain about a claim, mark it `[TO VERIFY]`. |
| 88 | + |
| 89 | +## Change boundaries |
| 90 | + |
| 91 | +- Don’t alter original meaning unless the task explicitly requests it. |
| 92 | +- Safe edits: clarity, consistency, formatting, style compliance, verified corrections. |
| 93 | + |
| 94 | + |
| 95 | +## General guidance |
| 96 | + |
| 97 | +- Always re-check `.github/instructions/` before large edits. |
| 98 | +- Keep diffs focused; avoid opportunistic large-scale refactors unless requested. |
| 99 | +- Consolidate repetitive phrasing where possible for readability. |
| 100 | +- Align with current product branding from `foundry-branding.instructions.md`. |
| 101 | + |
0 commit comments