Skip to content

Commit b57aa54

Browse files
authored
Merge pull request #8804 from microsoft/docs-instructions
Update docs prompts and instructions
2 parents 5b32def + 765d87a commit b57aa54

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

.github/instructions/docs-writing.instructions.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ These are our documentation writing style guidelines.
4747
* Avoid semicolons - use separate sentences instead.
4848
* Use question marks sparingly.
4949
* Don't use slashes (/) - use "or" instead.
50+
* Prefer single over double quotes, avoiding typographic quotes.
51+
* Only use apostrophe (U+0027) and quotes (U+0022), not left or right single or double quotation marks.
5052

5153
## Text formatting
5254

@@ -85,13 +87,19 @@ These are our documentation writing style guidelines.
8587
* Images have a descriptive and meaningful alt text that starts with "Screenshot showing" and ends with ".".
8688
* Videos have a descriptive and meaningful alt text or title that starts with "Video showing" and ends with ".".
8789

90+
## Lists
91+
92+
* Use asterisks (*) for lists of items.
93+
* Use numbered lists for steps in a procedure.
94+
* Keep list items parallel in structure.
95+
8896
## Numbered steps
8997

9098
* Write complete sentences with capitalization and periods
9199
* Use imperative verbs
92100
* Clearly indicate where actions take place (UI location)
93101
* For single steps, use a bullet instead of a number
94-
* When allowed, use angle brackets for menu sequences (File > Open)
102+
* Use angle brackets for menu sequences (File > Open)
95103

96104
## Terminology
97105

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
22
mode: agent
33
model: Claude Sonnet 4
4-
tools: ['codebase', 'vscodeAPI', 'githubRepo', 'search']
4+
tools: ['codebase', 'usages', 'vscodeAPI', 'githubRepo', 'search']
55
---
66
You are an expert in answering questions about Visual Studio Code, its features, and how to use it effectively. Explain how specific features work, give examples of usage scenarios.
7+
8+
Ground your answers in the source code by using #githubRepo microsoft/vscode and microsoft/vscode-copilot-chat.
9+
10+
Provide references to where you found the information in the source code.

.github/prompts/review-article.prompt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
mode: agent
3-
tools: ['codebase', 'vscodeAPI', 'problems', 'fetch', 'search']
3+
tools: ['codebase', 'vscodeAPI', 'problems', 'fetch', 'search', 'githubRepo']
44
description: You are a technical writer reviewing an article for clarity, conciseness, and adherence to the documentation writing style guidelines.
55
---
66
Review the article for clarity, conciseness, and adherence to our documentation [writing style guidelines](../instructions/docs-writing.instructions.md).

0 commit comments

Comments
 (0)