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
Copy file name to clipboardExpand all lines: .claude/skills/docs-add/SKILL.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
---
2
-
name: add
3
-
description: Adds new content to existing documentation pages while preserving the original structure and meaning. Integrates new sections, paragraphs, or information smoothly with appropriate transitions. Use when the user wants to add, insert, include, or append new content to existing pages without rewriting what's already there.
2
+
name: docs-add
3
+
description: Adds new content to a single documentation page while preserving the original structure and meaning. Integrates new sections, paragraphs, or information smoothly with appropriate transitions. Use when the user wants to add, insert, include, or append new content to existing pages without rewriting what's already there.
4
4
user-invocable: true
5
5
disable-model-invocation: true
6
6
---
7
7
8
-
> **After adding content:** Consider running `/polish` to improve clarity or `/proofread` to check for errors in the final result.
8
+
> **After adding content:** Consider running `/docs-polish` to improve clarity or `/docs-proofread` to check for errors in the final result.
9
9
10
10
Ask the user for the new content to add. Determine a suitable place to smoothly integrate the new content into the existing content, with appropriate transitions and formatting, while preserving the original meaning and structure of the page. Don't make changes to existing content unless necessary for clarity or coherence when adding the new content.
description: Performs comprehensive editing including reorganization, restructuring, and rephrasing while preserving original meaning and intent. Improves flow, strengthens weak phrasing, and enhances overall quality. Use when documentation needs significant structural improvements, better organization, or when the user mentions reorganize, restructure, rewrite, or enhance.
2
+
name: docs-enhance
3
+
description: Comprehensively edits a single documentation page including reorganization, restructuring, and rephrasing while preserving original meaning and intent. Improves flow, strengthens weak phrasing, and enhances overall quality. Use when documentation needs significant structural improvements, better organization, or when the user mentions reorganize, restructure, rewrite, or enhance.
4
4
user-invocable: true
5
5
disable-model-invocation: true
6
6
---
7
7
8
-
> **Skill progression:** This is the most intensive editing. If restructuring isn't needed, use `/polish` for clarity improvements or `/proofread` for basic fixes.
8
+
> **Skill progression:** This is the most intensive editing. If restructuring isn't needed, use `/docs-polish` for clarity improvements or `/docs-proofread` for basic fixes.
9
9
10
10
Perform holistic improvements, including reorganization and stronger phrasing, while preserving original intent. This goes beyond basic proofreading and polishing to enhance the overall quality and impact of the text. Consider restructuring sentences, paragraphs, or sections for better flow, replacing weak words with stronger alternatives, and improving clarity and consistency while maintaining the original meaning. However, avoid making changes just for the sake of change; every edit should serve a clear purpose in enhancing the text.
description: Proofreads a single documentation page 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 language and clarity, make more readable, check style guide compliance, or clean up documentation while preserving its structure.
4
+
user-invocable: true
5
+
disable-model-invocation: false
6
+
---
7
+
8
+
> **Skill progression:** This does everything `/docs-proofread` does plus clarity improvements and style guide enforcement. If only grammar and spelling fixes are needed, use `/docs-proofread`. For deeper reorganization, suggest `/docs-enhance`.
9
+
10
+
Improve clarity and readability without changing meaning, structure, or paragraph order:
11
+
12
+
**docs-polish should**:
13
+
* Read Mendix style guides first (in parallel): `grammar-formatting.md`, `terminology.md`, and `product-naming-guide.md` from `/content/en/docs/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
19
+
* Break up long, complex sentences for better readability
20
+
* Simplify wordy or awkward phrasing
21
+
* Improve word choice (more precise or accessible terms)
22
+
* Change passive voice to active voice where appropriate
23
+
* Remove bold and italics used for emphasis (reword or use alerts if needed)
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
26
+
27
+
**docs-polish should NOT**:
28
+
* Move paragraphs or restructure sections (that's `/docs-enhance`)
29
+
* Change technical meaning or accuracy
30
+
* Significantly increase document length
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.
32
+
33
+
Every edit should serve a clear purpose in making the text easier to read, scan, and understand.
34
+
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: Analyzes all changes in a pull request and generates suggestions for improvements, clarifications, inconsistencies, and structural changes without making any edits. Use when the user asks to review, analyze, audit, or provide feedback on a pull request, or when they want suggestions before making changes.
4
+
user-invocable: true
5
+
disable-model-invocation: false
6
+
---
7
+
8
+
Compare changes between the current branch and the base branch (typically `development`). Read the complete final state of each modified file, not just the diff, to ensure changes don't introduce inconsistencies with unchanged content.
9
+
10
+
Analyze all the changes in the current pull request or branch and return a list of suggestions or questions about any points to clarify, potential inconsistencies, and sections to restructure, add, or remove. Read the whole of each document modified in the pull request to ensure the changes do not make inconsistencies.
11
+
12
+
Follow links to other documents in the repo to check for inconsistencies if they seem to provide important related information.
13
+
14
+
Do not worry about possible invalid internal links to anchors in the repo as these will be picked up by a separate testing tool after the site has been built.
description: Checks a single documentation page 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
+
user-invocable: true
5
+
disable-model-invocation: false
6
+
---
7
+
8
+
> **Skill progression:** This is the lightest touch. If more clarity and style guide work is needed, suggest `/docs-polish`. For deeper restructuring, suggest `/docs-enhance`.
9
+
10
+
Do NOT rewrite, rephrase, or improve clarity. Proofread only:
* Ensure required front matter fields are present (title, url, description)
16
+
* Fix broken Markdown syntax
17
+
* Fix any capitalization and terminology inconsistencies
18
+
19
+
Do NOT:
20
+
* Rewrite sentences for clarity or conciseness
21
+
* Shorten or improve descriptions
22
+
* Change passive voice to active voice
23
+
* Simplify complex sentences
24
+
* Reorganize content
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
+
32
+
If you notice style or clarity issues that need improvement, finish proofreading first, then suggest that the user run `/docs-polish` for those improvements.
description: Analyzes a single documentation page and generates suggestions for improvements, clarifications, inconsistencies, and structural changes without making any edits. Use when the user asks to review, analyze, audit, or provide feedback on a documentation page or section, or when they want suggestions before making changes.
4
+
user-invocable: true
5
+
disable-model-invocation: false
6
+
---
7
+
8
+
Analyze the page and return a list of suggestions or questions about any points to clarify, potential inconsistencies, and sections to restructure, add, or remove. Make no edits.
0 commit comments