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:
- If the user has selected text in a file (check for
ide_selectiontags), only proofread the selected text in that file. Don't proofread the entire document. - If there's one open file (check for
ide_opened_filetags) and no selection, work on the entire file. - If there are multiple open files, list them and ask which to process.
- 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.
Source: mendix/docs — distributed by TomeVault.