Gestionnaire de documentation
/docsJe gère intelligemment la documentation du projet en analysant ce qui s’est réellement passé et en mettant à jour tous les docs pertinents.
Documentation Manager
I'll intelligently manage your project documentation by analyzing what actually happened and updating ALL relevant docs accordingly.
My approach:
- Analyze our entire conversation - Understand the full scope of changes
- Read ALL documentation files - README, CHANGELOG, docs/*, guides, everything
- Identify what changed - Features, architecture, bugs, performance, security, etc
- Update EVERYTHING affected - Not just one file, but all relevant documentation
- Maintain consistency - Ensure all docs tell the same story
I won't make assumptions - I'll look at what ACTUALLY changed and update accordingly.
If you refactored the entire architecture, I'll update architecture docs, README, migration guides, API docs, and anything else affected.
Mode 1: Documentation Overview (Default)
When you run /docs without context, I'll:
- Glob all markdown files (README, CHANGELOG, docs/*)
- Read each documentation file
- Analyze documentation coverage
- Present organized summary
Output format:
DOCUMENTATION OVERVIEW
├── README.md - [status: current/outdated]
├── CHANGELOG.md - [last updated: date]
├── CONTRIBUTING.md - [completeness: 85%]
├── docs/
│ ├── API.md - [status]
│ └── architecture.md - [status]
└── Total coverage: X%
KEY FINDINGS
- Missing: Setup instructions
- Outdated: API endpoints (3 new ones)
- Incomplete: Testing guideMode 2: Smart Update
When you run /docs update or after implementations, I'll:
- **Run
/understand** to analyze current codebase - Compare code reality vs documentation
- Identify what needs updating:
- New features not documented
- Changed APIs or interfaces
- Removed features still in docs
- New configuration options
- Updated dependencies
- Update systematically:
- README.md with new features/changes
- CHANGELOG.md with version entries
- API docs with new endpoints
- Configuration docs with new options
- Migration guides if breaking changes
Mode 3: Session Documentation
When run after a long coding session, I'll:
- Analyze conversation history
- List all changes made
- Group by feature/fix/enhancement
- Update appropriate docs
Updates will follow your project's documentation style and conventions, organizing changes by type (Added, Fixed, Changed, etc.) in the appropriate sections.
Mode 4: Context-Aware Updates
Based on what happened in session:
- After new feature: Update README features, add to CHANGELOG
- After bug fixes: Document in CHANGELOG, update troubleshooting
- After refactoring: Update architecture docs, migration guide
- After security fixes: Update security policy, CHANGELOG
- After performance improvements: Update benchmarks, CHANGELOG
Smart Documentation Rules
- Preserve custom content - Never overwrite manual additions
- Match existing style - Follow current doc formatting
- Semantic sections - Add to correct sections
- Version awareness - Respect semver in CHANGELOG
- Link updates - Fix broken internal links
Integration with Commands
Works seamlessly with:
/understand- Get current architecture first/contributing- Update contribution guidelines/test- Document test coverage changes/scaffold- Add new component docs/security-scan- Update security documentation
Documentation Rules
ALWAYS:
- Read existing docs completely before any update
- Find the exact section that needs updating
- Update in-place, never duplicate
- Preserve custom content and formatting
- Only create new docs if absolutely essential (README missing, etc)
Preserve sections:
<!-- CUSTOM:START -->
User's manual content preserved
<!-- CUSTOM:END -->Smart CHANGELOG:
- Groups changes by type
- Suggests version bump (major/minor/patch)
- Links to relevant PRs/issues
- Maintains chronological order
Important: I will NEVER:
- Delete existing documentation
- Overwrite custom sections
- Change documentation style drastically
- Add AI attribution markers
- Create unnecessary documentation
After analysis, I'll ask: "How should I proceed?"
- Update all outdated docs
- Focus on specific files
- Create missing documentation
- Generate migration guide
- Skip certain sections
Additional Scenarios & Integrations
When to Use /docs
Simply run /docs after any significant work:
- After
/understand- Ensure docs match code reality - After
/fix-todosor bug fixes - Update all affected documentation - After
/scaffoldor new features - Document what was added - After
/security-scanor/review- Document findings and decisions - After major refactoring - Update architecture, migration guides, everything
I'll figure out what needs updating based on what actually happened, not rigid rules.
Documentation Types
I can manage:
- API Documentation - Endpoints, parameters, responses
- Database Schema - T