Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
name: add
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.
name: docs-add
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.
user-invocable: true
disable-model-invocation: true
---

> **After adding content:** Consider running `/polish` to improve clarity or `/proofread` to check for errors in the final result.
> **After adding content:** Consider running `/docs-polish` to improve clarity or `/docs-proofread` to check for errors in the final result.

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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
name: enhance
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.
name: docs-enhance
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.
user-invocable: true
disable-model-invocation: true
---

> **Skill progression:** This is the most intensive editing. If restructuring isn't needed, use `/polish` for clarity improvements or `/proofread` for basic fixes.
> **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.

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.
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
name: polish
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.
name: docs-polish
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 clarity, make more readable, or clean up documentation while preserving its structure.
user-invocable: true
disable-model-invocation: false
---

> **Skill progression:** This preserves structure. If only basic fixes are needed, use `/proofread`. For deeper reorganization, suggest `/enhance`.
> **Skill progression:** This preserves structure. If only basic fixes are needed, use `/docs-proofread`. For deeper reorganization, suggest `/docs-enhance`.

First, use the Skill tool to invoke the `proofread` skill.
First, use the Skill tool to invoke the `docs-proofread` skill.

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

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

**Polish should NOT**:
* Move paragraphs or restructure sections (that's `/enhance`)
* Move paragraphs or restructure sections (that's `/docs-enhance`)
* Change technical meaning or accuracy
* Significantly increase document length
* Modify code samples (flag issues instead)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
name: proofread
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.
name: docs-proofread
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.
user-invocable: true
disable-model-invocation: false
---

> **Skill progression:** This is the lightest touch. If more clarity work is needed, suggest `/polish`. For deeper restructuring, suggest `/enhance`.
> **Skill progression:** This is the lightest touch. If more clarity work is needed, suggest `/docs-polish`. For deeper restructuring, suggest `/docs-enhance`.

Proofread the document for technical correctness only. Do NOT rewrite, rephrase, or improve clarity:

Expand All @@ -24,4 +24,4 @@ Do NOT:
* Simplify complex sentences
* Reorganize content

If you notice style or clarity issues that need improvement, finish proofreading first, then suggest the user run `/polish` for those improvements.
If you notice style or clarity issues that need improvement, finish proofreading first, then suggest that the user run `/docs-polish` for those improvements.
8 changes: 8 additions & 0 deletions .claude/skills/docs-review/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: docs-review
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.
user-invocable: true
disable-model-invocation: false
---

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.
8 changes: 0 additions & 8 deletions .claude/skills/review/SKILL.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ Do not modify `.claude/settings.json` or other files in the `.claude/` directory

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

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

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

Expand Down
Loading