mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-05-09 07:42:39 +02:00
20 lines
659 B
Markdown
20 lines
659 B
Markdown
|
---
|
||
|
|
name: validate-doc
|
||
|
|
description: Validate documentation against standards and best practices
|
||
|
|
menu-code: VD
|
||
|
|
---
|
||
|
|
|
||
|
|
# Validate Documentation
|
||
|
|
|
||
|
|
Review the specified document against documentation best practices along with anything additional the user asked you to focus on.
|
||
|
|
|
||
|
|
## Process
|
||
|
|
|
||
|
|
1. **Load the document** — Read the specified document fully
|
||
|
|
2. **Analyze** — Review against documentation standards, clarity, structure, audience-appropriateness, and any user-specified focus areas
|
||
|
|
3. **Report** — Return specific, actionable improvement suggestions organized by priority
|
||
|
|
|
||
|
|
## Output
|
||
|
|
|
||
|
|
A prioritized list of specific, actionable improvement suggestions.
|