Skip to content

Commit 48d393a

Browse files
committed
Update cross links and make descriptins more consistent
1 parent 95eeab7 commit 48d393a

6 files changed

Lines changed: 16 additions & 16 deletions

File tree

.claude/skills/docs-add/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
name: docs-add
3-
description: Adds new content to an existing 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.
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.
44
user-invocable: true
55
disable-model-invocation: true
66
---
77

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.
99
1010
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.
1111

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
name: docs-enhance
3-
description: On a single documentation page, 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.
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.
44
user-invocable: true
55
disable-model-invocation: true
66
---
77

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.
99
1010
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.

.claude/skills/docs-polish/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ user-invocable: true
55
disable-model-invocation: false
66
---
77

8-
> **Skill progression:** This preserves structure. If only basic fixes are needed, use `/proofread`. For deeper reorganization, suggest `/enhance`.
8+
> **Skill progression:** This preserves structure. If only basic fixes are needed, use `/docs-proofread`. For deeper reorganization, suggest `/docs-enhance`.
99
10-
First, use the Skill tool to invoke the `proofread` skill.
10+
First, use the Skill tool to invoke the `docs-proofread` skill.
1111

1212
Then immediately continue: improve clarity and readability without changing meaning, structure, or paragraph order:
1313

@@ -22,7 +22,7 @@ Then immediately continue: improve clarity and readability without changing mean
2222
* Ensure consistent application of Microsoft Writing Style Guide
2323

2424
**Polish should NOT**:
25-
* Move paragraphs or restructure sections (that's `/enhance`)
25+
* Move paragraphs or restructure sections (that's `/docs-enhance`)
2626
* Change technical meaning or accuracy
2727
* Significantly increase document length
2828
* Modify code samples (flag issues instead)

.claude/skills/docs-proofread/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
name: docs-proofread
3-
description: In a documentation page, 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 a single documentation page 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.
44
user-invocable: true
55
disable-model-invocation: false
66
---
77

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 work is needed, suggest `/docs-polish`. For deeper restructuring, suggest `/docs-enhance`.
99
1010
Proofread the document for technical correctness only. Do NOT rewrite, rephrase, or improve clarity:
1111

@@ -24,4 +24,4 @@ Do NOT:
2424
* Simplify complex sentences
2525
* Reorganize content
2626

27-
If you notice style or clarity issues that need improvement, finish proofreading first, then suggest that the user run `/polish` for those improvements.
27+
If you notice style or clarity issues that need improvement, finish proofreading first, then suggest that the user run `/docs-polish` for those improvements.

.claude/skills/docs-review/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: docs-review
3-
description: Analyzes a 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 documentation, or when they want suggestions before making changes.
3+
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 documentation, or when they want suggestions before making changes.
44
user-invocable: true
55
disable-model-invocation: false
66
---

content/en/docs/community-tools/contribute-to-mendix-docs/using-ai-tools.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@ Do not modify `.claude/settings.json` or other files in the `.claude/` directory
5050

5151
This repository includes custom Claude Code skills optimized for documentation work:
5252

53-
* `/proofread` - Checks spelling, grammar, punctuation, and basic Markdown formatting
54-
* `/polish` - Improves clarity, readability, and word choice without changing meaning
55-
* `/enhance` - Performs comprehensive editing including reorganization, restructuring, and stronger phrasing
56-
* `/review` - Analyzes documentation and generates suggestions for improvements
57-
* `/add` - Adds new content to an existing page while preserving original structure
53+
* `/docs-proofread` - Checks spelling, grammar, punctuation, and basic Markdown formatting
54+
* `/docs-polish` - Improves clarity, readability, and word choice without changing meaning
55+
* `/docs-enhance` - Performs comprehensive editing including reorganization, restructuring, and stronger phrasing
56+
* `/docs-review` - Analyzes documentation and generates suggestions for improvements
57+
* `/docs-add` - Adds new content to an existing page while preserving original structure
5858

5959
These skills are available to all contributors using Claude Code with this repository.
6060

0 commit comments

Comments
 (0)