Use Cases
Update Documentation
Keep your docs current when you ship features or make changes that affect users
Update Documentation
When you ship new features or make breaking changes, trigger the Documentation agent to update your user-facing docs. The agent analyzes your code changes and updates documentation across multiple repositories to keep everything in sync.Documentation Types
- API Documentation: Auto-generate API docs from code
- README Files: Create and update project README files
- Code Comments: Add meaningful inline documentation
- User Guides: Generate user-facing documentation
- Architecture Docs: Document system architecture and design decisions
Specialized Documentation Agent
- User-Impact Focus: Only updates documentation for changes that affect user experience
- Seamless Integration: Updates blend naturally without explicitly mentioning changes
- Style Preservation: Maintains existing documentation tone, voice, and structure
- Quality Standards: Follows “first of its kind” rule to avoid inappropriate content additions
- Comprehensive Research: Thoroughly analyzes both code changes and existing documentation
- Cross-Repository Intelligence: Maps repository ecosystems and dependency relationships
Workflow
- Repository Discovery: Agent maps your repository ecosystem and dependencies
- Change Detection: Monitors code changes across all connected repositories
- Impact Analysis: Determines which documentation needs updates
- Cross-Repo Updates: Automatically updates docs in multiple repositories
- Sync Verification: Ensures all documentation remains consistent and up-to-date
When to Use
- After shipping new features: Update docs to reflect new capabilities
- API changes: Keep API documentation current with code changes
- Breaking changes: Ensure migration guides and docs are updated
- Multi-repo projects: Sync documentation across related repositories
- User-facing changes: Update guides when workflows change