Analyzes code changes and identifies documentation gaps. Scans git history, catalogs existing docs, and generates comprehensive analysis reports.
Analyzes code changes to identify documentation gaps and generates prioritized update reports.
/plugin marketplace add datamaker-kr/synapse-claude-marketplace/plugin install platform-dev-team-common@synapse-marketplaceThis skill is limited to using the following tools:
README.mdThis skill specializes in analyzing codebases to identify documentation gaps and assess the impact of code changes on existing documentation. It provides structured reports to guide documentation updates.
Use this skill when:
Scan and catalog all documentation files in the repository:
Documentation Files to Find:
README.md (root and subdirectories)docs/ directory contentsCONTRIBUTING.mdCHANGELOG.md*.md files throughout the codebaseUse Glob and Read tools:
# Find all markdown files
Glob: "**/*.md"
# Find documentation directories
Glob: "**/docs/**/*"
# Find API specs
Glob: "**/*.{yaml,yml,json}" (for OpenAPI specs)
Catalog Output:
Use Bash tool to analyze recent code changes and identify affected components.
Git Commands to Run:
# Get recent commits (last 10-50 depending on activity)
git log --oneline -20
# Get detailed diff for recent changes
git diff HEAD~10..HEAD --stat
# Identify changed files by type
git diff HEAD~10..HEAD --name-only
# Get commit messages for context
git log HEAD~10..HEAD --pretty=format:"%h - %s"
Analyze:
Based on file changes, determine which components were modified:
Backend Projects (Django, FastAPI, Express, etc.):
Frontend Projects (React, Vue, Angular, etc.):
Infrastructure (Terraform, Kubernetes, etc.):
Use Grep to Search:
# Find API endpoint definitions
Grep: pattern="@app\\.(get|post|put|delete)" (FastAPI)
Grep: pattern="class.*ViewSet|class.*APIView" (Django)
Grep: pattern="router\\.(get|post)" (Express)
# Find model definitions
Grep: pattern="class.*\\(models\\.Model\\)" (Django)
Grep: pattern="class.*\\(BaseModel\\)" (Pydantic/FastAPI)
# Find component definitions
Grep: pattern="function.*Component|const.*Component" (React)
Grep: pattern="export default.*defineComponent" (Vue)
Compare code changes against existing documentation to identify gaps.
Gap Categories:
Missing Documentation:
Outdated Documentation:
Incomplete Documentation:
Inconsistent Documentation:
For each gap, determine severity and priority:
Severity Levels:
Priority Factors:
Create a structured report with findings:
Report Format:
# Documentation Analysis Report
## Summary
- Total documentation files: X
- Files analyzed: Y
- Gaps identified: Z
- Last commit analyzed: [commit hash]
## Existing Documentation
### Complete ✅
- [file path]: [brief description]
### Outdated ⚠️
- [file path]: [what's outdated]
### Missing ❌
- [expected file]: [why it's needed]
## Code Changes Detected
### Modified Components
- [component type]: [list of components]
### Impact Areas
- [area]: [description of changes]
## Documentation Gaps
### Critical 🔴
1. **[Gap Title]**
- **Affected File**: [file path or "Not exists"]
- **Issue**: [description]
- **Code Reference**: [file:line or component]
- **Recommendation**: [what to add/update]
### High Priority 🟡
[same format as above]
### Medium Priority 🟢
[same format as above]
### Low Priority 🔵
[same format as above]
## Recommendations
### Immediate Actions
1. [action item]
2. [action item]
### Suggested Updates
- **[file path]**: [specific section to update]
- **New files**: [files to create]
### Diagrams Needed
- [diagram type]: [what it should show]
- [diagram type]: [what it should show]
## Next Steps
1. Review this report
2. Prioritize gap remediation
3. Invoke docs-bootstrapper for missing structure (if needed)
4. Update documentation with approved changes
The report should be:
This skill is designed to work with:
Scenario: User made changes to authentication system
docs-analyzer actions:
While designed for orchestration, this skill can be invoked directly:
User: /docs-analyzer
Skill: Analyzes codebase and generates comprehensive documentation gap report
This allows developers to audit documentation health independently from the update workflow.
Activates when the user asks about AI prompts, needs prompt templates, wants to search for prompts, or mentions prompts.chat. Use for discovering, retrieving, and improving prompts.
Search, retrieve, and install Agent Skills from the prompts.chat registry using MCP tools. Use when the user asks to find skills, browse skill catalogs, install a skill for Claude, or extend Claude's capabilities with reusable AI agent components.
Creating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or particle systems. Create original algorithmic art rather than copying existing artists' work to avoid copyright violations.