Docs Review

Review documentation for style guide compliance

Docs Review

The Docs Review skill provides context injection for reviewing documentation against the CLEO style guide.

Overview

Property	Value
Skill ID	ct-docs-review
Tier	3 (Support)
Protocol	consensus
Tags	documentation, review

Review Checklist

Language and Tone

• No formal language (“utilize”, “leverage”, “offerings”)
• “People/companies” instead of “users”
• No excessive exclamation points
• No “easy” or “simple”
• Direct, conversational tone

Structure

• Important information leads (not buried)
• Headings state the point
• Short paragraphs (3-4 sentences)
• Lists for multiple items

Technical Quality

• Code examples actually work
• Links are descriptive (never “click here”)
• Proper code block language tags
• Correct technical terminology

Formatting

• Sentence case headings
• Consistent spacing
• Tables for structured comparisons
• Proper markdown syntax

Review Process

Phase 1: Structure Review

1. Check document organization
2. Verify headings are informative
3. Confirm important info leads

Phase 2: Language Review

1. Scan for corporate/formal language
2. Check for banned words
3. Verify conversational tone

Phase 3: Technical Review

1. Test all code examples
2. Verify links work
3. Check technical accuracy

Phase 4: Format Review

1. Confirm consistent formatting
2. Check markdown syntax
3. Verify proper indentation

Review Output Format

# Documentation Review: {FILE_PATH}

## Summary

- **Status**: PASS | NEEDS_REVISION
- **Issues Found**: {N}

## Issues

### Issue 1: {Category}

**Location**: Line {N}
**Problem**: {Description}
**Suggestion**: {How to fix}

### Issue 2: {Category}

...

## Positive Notes

- {What was done well}

Severity Levels

Level	Description	Action
Critical	Incorrect information, broken code	Must fix
Major	Style guide violation	Should fix
Minor	Formatting inconsistency	Nice to fix
Suggestion	Enhancement opportunity	Optional

Integration with Documentor

This skill is invoked by ct-documentor during the review phase to:

• Validate documentation before completion
• Ensure style guide compliance
• Provide actionable feedback

Related Skills

• Documentor - Orchestrates documentation
• Docs Write - Writes documentation
• Validator - General validation