Agent skill
executing-comprehensive-reviews
Use when reviewing content for clarity, generating questions, or checking alignment. Triggers on "review for clarity", "suggest questions", "check alignment", "comprehensive review".
Install this agent skill to your Project
npx add-skill https://github.com/jayminwest/agentic-engineering-book/tree/main/.claude/skills/executing-comprehensive-reviews
SKILL.md
Executing Comprehensive Reviews
Guide for content review workflows including clarity improvements, question generation, and book-implementation alignment validation.
Instructions
Step 1: Parse Review Requirement
Extract from request:
- Target: Specific file, chapter, or pattern
- Review Type: clarity | questions | alignment | comprehensive
- Scope: Single file, chapter, full codebase
Type Detection:
- Contains "clarity" or "clear" -> Clarity review
- Contains "question" or "deeper" -> Questions review
- Contains "align" or "implementation" -> Alignment check
- Contains "comprehensive" or "full" -> All types
- Ambiguous -> Ask user which type(s)
Step 2: Optional Exploration
If requirement is broad or exploratory:
-
Search for relevant content
Glob: chapters/**/*.md Grep: {topic keywords} -
Read identified files to assess coverage
-
Create exploration summary:
- Relevant entries discovered
- Content gaps identified
- Relationship mappings
Skip exploration if:
- Specific file path provided
- Review type is alignment (has own discovery)
- User requests direct review only
Step 3: Execute Review Type(s)
Clarity Review
For improving readability without changing voice:
- Read target content completely
- Identify clarity issues:
- Ambiguous sentences
- Missing transitions
- Jargon without context
- Overly complex structure
- Propose improvements preserving authorial voice
- Present suggestions to user for approval
- Apply approved changes
- Update
last_updatedin frontmatter
Voice preservation checklist:
- Maintains first-person where used
- Keeps practical, experience-based tone
- Preserves original examples
- Doesn't over-formalize
Questions Review
For generating follow-up questions to deepen content:
- Read target content completely
- Identify deepening opportunities:
- Claims that could use evidence
- Patterns that could use examples
- Concepts that connect to other chapters
- Edge cases not addressed
- Generate 3-5 follow-up questions
- Present questions to user for selection
- Add selected questions under "### Follow-up" heading
- Update
last_updatedin frontmatter
Question quality criteria:
- Answerable from experience/research
- Leads to actionable content
- Not already covered in file
- Connects to reader needs
Alignment Check
For validating book-implementation consistency:
-
Inventory phase:
- Scan CLAUDE.md for documented commands/agents
- List all
.claude/files and structures
-
Cross-reference phase:
- Check each documented item exists
- Check each implemented item is documented
-
Pattern validation:
- Verify documented patterns match implementation
- Check file paths are accurate
-
Link validation:
- Test internal links in documentation
- Verify file references resolve
-
Report findings:
- Orphans: Exist but undocumented
- Phantoms: Documented but missing
- Broken links: Invalid references
- Pattern compliance: Match/mismatch
Alignment is read-only - no modifications, just diagnostics.
Step 4: Synthesize Findings
Collect outputs from all executed reviews:
From Exploration (if run):
- Entries discovered
- Gaps identified
- Relationships mapped
From Clarity:
- Issues found
- Suggestions approved
- Files modified
From Questions:
- Questions generated
- Questions added
- Themes identified
From Alignment:
- Orphan count
- Phantom count
- Broken links
- Compliance status
Step 5: Prioritize Recommendations
High Priority (Breaking issues)
- Alignment: Missing implementations, broken links
- Clarity: Confusing core concepts
Medium Priority (Content gaps)
- Questions: Unanswered follow-ups
- Exploration: Missing relationships
Low Priority (Polish)
- Clarity: Minor improvements
- Style: Consistency tweaks
Step 6: Report Results
## Review Complete
**Requirement:** {original requirement}
### Reviews Executed
| Type | Status | Key Findings |
|------|--------|--------------|
| Exploration | Complete/Skipped | {entries} found |
| Clarity | Complete/Skipped | {issues} found, {applied} fixed |
| Questions | Complete/Skipped | {count} generated |
| Alignment | Complete/Skipped | {gaps} identified |
### Priority Recommendations
**High:** {numbered list}
**Medium:** {numbered list}
**Low:** {numbered list}
### Files Modified
{list with brief descriptions}
### Next Steps
- {context-specific actions}
Key Principles
Type Routing Matrix
| Pattern | Route To |
|---|---|
| "review {file} for clarity" | Clarity only |
| "suggest questions for {file}" | Questions only |
| "check alignment" | Alignment only |
| "comprehensive review of {file}" | Clarity + Questions |
| "review chapter {N}" | Explore -> Clarity + Questions |
Sequential Execution
- Exploration -> Review -> Synthesis
- Each stage informs the next
- Don't parallelize within a review
User Choice Points
- Which review types to run
- Whether to apply clarity suggestions
- Which questions to add
- Alignment runs automatically (read-only, safe)
Synthesis Over Pass-Through
- Don't concatenate reports
- Extract key findings across reviews
- Prioritize by impact
- Provide actionable next steps
Examples
Example 1: Clarity review on specific file
Request: "Review chapters/6-patterns/2-self-improving-experts.md for clarity"
Execute:
- Skip exploration (file specified)
- Read file completely
- Identify 3 clarity issues
- Present suggestions
- User approves 2
- Apply changes
- Update frontmatter
Report: "2 clarity improvements applied"
Example 2: Generate questions for content
Request: "Suggest follow-up questions for chapter 8"
Execute:
- Explore chapter 8 structure
- Find 4 relevant entries
- Generate questions for each
- Present: 12 questions total
- User selects 5
- Add to respective files
Report: "5 questions added across 4 files"
Example 3: Alignment check
Request: "Check alignment between book and implementation"
Execute:
- Inventory CLAUDE.md references
- Scan .claude/ structure
- Cross-reference
Findings:
- 2 orphan commands (exist, undocumented)
- 1 phantom reference (documented, missing)
- 3 broken internal links
Report: "6 alignment issues found, 1 high priority"
Example 4: Comprehensive chapter review
Request: "Comprehensive review of chapter 7"
Execute:
- Explore: Find 6 entries
- Alignment: Check chapter references
- Clarity: Review each entry
- Questions: Generate follow-ups
Synthesize:
- High: 1 broken link
- Medium: 3 clarity issues
- Low: 8 potential questions
Report with prioritized action list
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
creating-new-skills
Creates new Agent Skills for AI Agents following best practices and documentation. Use when the user wants prompts 'create a new skill ...' or 'use your meta skill to ...'.
orchestrating-knowledge-workflows
Use when implementing plan-build-improve cycles for content updates. Triggers on "knowledge workflow", "plan then build", "spec-driven implementation".
researching-external-sources
Use when researching documentation, papers, or articles for insights. Triggers on "research external", "find sources", "literature review", "what do the docs say".
managing-book-operations
Use when generating table of contents, validating metadata, or exploring book content. Triggers on "generate TOC", "table of contents", "validate frontmatter", "book chat".
obsidian-vault
Search, create, and manage notes in the Obsidian vault with wikilinks and index notes. Use when user wants to find, create, or organize notes in Obsidian.
handoff
Compact the current conversation into a handoff document for another agent to pick up.
Didn't find tool you were looking for?