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
description: Proofreads documentation and improves clarity, readability, and word choice without changing meaning or reorganizing structure. Simplifies complex sentences, applies style guide standards, and converts passive voice to active voice. Use when the user wants to polish, improve clarity, make more readable, or clean up documentation while preserving its structure.
3
+
description: Proofreads documentation and improves clarity, readability, and word choice without changing meaning or reorganizing structure. Simplifies complex sentences, applies style guide standards, and converts passive voice to active voice. Use when the user wants to polish, improve clarity, make more readable, check style guide compliance, improve language, or clean up documentation while preserving its structure.
4
4
user-invocable: true
5
5
disable-model-invocation: false
6
6
---
7
7
8
-
> **Skill progression:** This preserves structure. If only basic fixes are needed, use `/proofread`. For deeper reorganization, suggest `/enhance`.
8
+
> **Skill progression:** This does everything `/proofread` does plus clarity improvements and style guide enforcement. If only grammar and spelling fixes are needed, use `/proofread`. For deeper reorganization, suggest `/enhance`.
9
9
10
-
First, use the Skill tool to invoke the `proofread` skill.
11
-
12
-
Then immediately continue: improve clarity and readability without changing meaning, structure, or paragraph order:
10
+
Improve clarity and readability without changing meaning, structure, or paragraph order:
13
11
14
12
**Polish should**:
13
+
* Read Mendix style guides first (in parallel): `grammar-formatting.md`, `terminology.md`, and `product-naming-guide.md` from `/community-tools/contribute-to-mendix-docs/style-guide/`
14
+
* Fix all spelling, grammar, and punctuation errors
15
+
* Add missing alt text to images (use simple, factual descriptions)
16
+
* Ensure required front matter fields are present (title, url, description) and make descriptions concise and action-oriented
17
+
* Fix broken Markdown syntax
18
+
* Fix capitalization and terminology inconsistencies
15
19
* Break up long, complex sentences for better readability
16
20
* Simplify wordy or awkward phrasing
17
21
* Improve word choice (more precise or accessible terms)
18
22
* Change passive voice to active voice where appropriate
19
-
* Make front matter descriptions more concise and action-oriented
20
-
* Apply all style standards from project instructions (tone, formatting, terminology)
21
23
* Remove bold and italics used for emphasis (reword or use alerts if needed)
22
-
* Ensure consistent application of Microsoft Writing Style Guide
24
+
* Apply Mendix style guide standards (overrides the Microsoft Writing Style Guide)
25
+
* Apply Microsoft Writing Style Guide standards, unless they conflict with the Mendix style guide standards
23
26
24
27
**Polish should NOT**:
25
28
* Move paragraphs or restructure sections (that's `/enhance`)
26
29
* Change technical meaning or accuracy
27
30
* Significantly increase document length
28
-
*Modify code samples (flag issues instead)
31
+
*Change command syntax, code identifiers, variable names, placeholders, or any other text that appears in code formatting (inline backticks or code blocks). Code-formatted text represents literal technical content that must remain unchanged. If you notice an issue with code-formatted text, flag it in the chat but don't edit it directly.
29
32
30
33
Every edit should serve a clear purpose in making the text easier to read, scan, and understand.
31
34
32
-
Do not change any code samples directly, but flag any code issues or inconsistencies in the chat.
35
+
Priority order for determining scope:
36
+
1. If the user has selected text in a file (check for `ide_selection` tags), only polish the selected text in that file. Don't polish the entire document.
37
+
2. If there's one open file (check for `ide_opened_file` tags) and no selection, work on the entire file.
38
+
3. If there are multiple open files, list them and ask which to process.
description: Checks and fixes spelling, grammar, punctuation, basic Markdown formatting, alt text, and required front matter fields. Makes minimal technical corrections without rewording or restructuring. Use when the user asks to proofread, check for errors, fix typos, or perform a light technical review of documentation.
3
+
description: Checks and fixes spelling, grammar, punctuation, basic Markdown formatting, and required front matter fields. Makes minimal corrections without rewording or restructuring. Use when the user asks to proofread, check for spelling and grammar errors, or fix typos.
4
4
user-invocable: true
5
5
disable-model-invocation: false
6
6
---
7
7
8
-
> **Skill progression:** This is the lightest touch. If more clarity work is needed, suggest `/polish`. For deeper restructuring, suggest `/enhance`.
8
+
> **Skill progression:** This is the lightest touch. If more clarity and style guide work is needed, suggest `/polish`. For deeper restructuring, suggest `/enhance`.
9
9
10
-
Proofread the document for technical correctness only. Do NOT rewrite, rephrase, or improve clarity:
10
+
Do NOT rewrite, rephrase, or improve clarity. Proofread only:
* Add missing alt text to images (use simple, factual descriptions)
16
15
* Ensure required front matter fields are present (title, url, description)
17
16
* Fix broken Markdown syntax
18
17
* Fix any capitalization and terminology inconsistencies
@@ -24,4 +23,10 @@ Do NOT:
24
23
* Simplify complex sentences
25
24
* Reorganize content
26
25
26
+
Priority order for determining scope:
27
+
1. If the user has selected text in a file (check for `ide_selection` tags), only proofread the selected text in that file. Don't proofread the entire document.
28
+
2. If there's one open file (check for `ide_opened_file` tags) and no selection, work on the entire file.
29
+
3. If there are multiple open files, list them and ask which to process.
30
+
4. If no files are open, ask for a file path.
31
+
27
32
If you notice style or clarity issues that need improvement, finish proofreading first, then suggest the user run `/polish` for those improvements.
Copy file name to clipboardExpand all lines: CLAUDE.md
+17-6Lines changed: 17 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
<!-- markdownlint-disable-file -->
4
4
5
-
**Your role**: Edit and review Markdown documentation files under `content/en/docs/` following Microsoft Writing Style Guide and the project-specific conventions below.
5
+
**Your role**: Edit and review Markdown documentation files under `content/en/docs/` following the style guidance and project-specific conventions below.
6
6
7
7
## Instruction Precedence
8
8
@@ -12,8 +12,9 @@ When instructions conflict, follow this order of precedence:
12
12
2. Task-specific prompt files in `.github/prompts/*.prompt.md` (for Copilot) or skills in `.claude/skills/*/SKILL.md` (for Claude) when explicitly referenced or invoked.
13
13
3. Overlay instruction files (for example, `.github/release-notes-instructions.md`) when path-scoped.
14
14
4. This file (`CLAUDE.md`).
15
-
5. Existing conventions in nearby pages within the same folder.
16
-
6. Microsoft Writing Style Guide.
15
+
5. Mendix Style Guide files in `content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/` for detailed grammar, terminology, and formatting rules.
16
+
6. Existing conventions in nearby pages within the same folder.
17
+
7. Microsoft Writing Style Guide.
17
18
18
19
### Critical Constraints
19
20
@@ -73,7 +74,7 @@ Before creating a new file, use Glob to explore the directory structure and unde
73
74
74
75
## Style Standards
75
76
76
-
***Guiding manual** – Microsoft Writing Style Guide (https://learn.microsoft.com/style-guide/). Apply grammar, inclusive language, terminology, and formatting rules from that document.
77
+
***Guiding manual** – Mendix-specific style guides (see subsection below) extend and customize the Microsoft Writing Style Guide (https://learn.microsoft.com/style-guide/). Consult the Mendix style guides first for grammar, inclusive language, terminology, and formatting rules; use MSG as fallback for topics not covered by Mendix guides.
77
78
***Tone** – Clear, concise, active voice; use imperative mood for procedures; second person (you/your) when addressing readers. Keep a conversational, straightforward tone. Present tense. Use American English and write for a global audience. Prefer short, everyday words; avoid or explain jargon. Keep it simple—short sentences and fragments are easier to scan and read, and prune excess words. Avoid marketing language.
78
79
***Terminology** – Capitalize product names (Mendix, Studio Pro, Developer Portal); use "microflow", "nanoflow", etc. consistently. Never use e.g. or i.e.
79
80
***Text formatting** – Reserve bold for UI labels, button names, menu items, or other interface text, or for introductions in list items. Don't use italics except to refer to titles and sections. Use wording or alert shortcodes for emphasis; don't use text formatting for emphasis. Use code font only to wrap literal code, filenames, paths, or command-line input. Use `<kbd>` for keyboard shortcuts.
@@ -82,9 +83,19 @@ Before creating a new file, use Glob to explore the directory structure and unde
82
83
***Indentation** – Four spaces for sub-lists and nested content. Alerts in lists are an exception: don't indent alert lines but do omit preceding blank line.
83
84
***Links** – Use absolute paths starting with a leading slash (`/deployment/`). Use descriptive link text such as the page title, not "click here". To link to a heading, add an anchor ID (`{#anchor-id}`) next to the heading and use that ID in the URL (for example, `[Section title](/path/to/page#anchor-id)` to link to a heading in another page or `[Section title](#anchor-id)` to link to a heading in the same page).
84
85
***Images** – Always include `alt` text (or `alt=""` if decorative). Use W3C guidelines. Reference images with the `figure` shortcode.
85
-
***Code** – Use fenced code blocks with language specifier.
86
+
***Code** – Use fenced code blocks with language specifier. Do not modify text that appears in code formatting (inline backticks or code blocks), even to fix apparent inconsistencies or apply naming conventions.
86
87
87
-
Project‑specific preferences are documented in the templates and in `community-tools` example pages; consult them for tricky formatting cases.
88
+
### Mendix-Specific Style Guides
89
+
90
+
For detailed guidance beyond the basics above, consult these Mendix style guide files in `content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/`:
91
+
92
+
***`grammar-formatting.md`** – Grammar and formatting rules including acronyms, active/passive voice, alerts, bold/italics, capitalization, contractions, dashes, dates, emphasis, headings, lists, numbers, person, verb tense, keyboard shortcuts, URL handling, and cross-reference conventions. This is the most detailed style reference.
93
+
***`terminology.md`** – General terminology guidance for common terms, with capitalization and hyphenation rules.
94
+
***`product-naming-guide.md`** – Reference for Mendix product names and other Mendix terms.
95
+
96
+
When encountering style questions not covered in this file, read the relevant style guide file above before falling back to the Microsoft Writing Style Guide.
97
+
98
+
Project‑specific preferences are also documented in the templates; consult them for tricky formatting cases.
0 commit comments