docs-proofread

star 181

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.

mendix By mendix schedule Updated 5/29/2026

name: docs-proofread 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. user-invocable: true disable-model-invocation: false

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.

Do NOT rewrite, rephrase, or improve clarity. Proofread only:

  • Spelling: Fix typos and misspellings
  • Grammar: Fix grammatical errors (subject-verb agreement, tense consistency, etc.)
  • Basic formatting checks:
    • Ensure required front matter fields are present (title, url, description)
    • Fix broken Markdown syntax
    • Fix any capitalization and terminology inconsistencies

Do NOT:

  • Rewrite sentences for clarity or conciseness
  • Shorten or improve descriptions
  • Change passive voice to active voice
  • Simplify complex sentences
  • Reorganize content
  • Remove Markdown comments

Priority order for determining scope:

  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.
  2. If there's one open file (check for ide_opened_file tags) and no selection, work on the entire file.
  3. If there are multiple open files, list them and ask which to process.
  4. If no files are open, ask for a file path.

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

Install via CLI
npx skills add https://github.com/mendix/docs --skill docs-proofread
Repository Details
star Stars 181
call_split Forks 787
navigation Branch main
article Path SKILL.md
Occupations
More from Creator