Module 1
Introduction - GenAI pour Documentation
Introduction - GenAI pour Documentation
20min
Leçons vidéo
Exercices
Lab pratique
Pourquoi GenAI révolutionne la documentation
Vue d'ensemble des cas d'usage
ROI : -75% temps documentation
Documentation as Code avec GenAI
Module 2
Technical Documentation
Technical Documentation
API, Architecture) (45min
Leçons vidéo
Exercices
Lab pratique
API Documentation : REST, GraphQL
- Génération OpenAPI/Swagger à partir de code
- Endpoint descriptions automatiques
- Request/Response examples
- Authentication & error codes documentation
- Exercice : Documenter API complète en 10 minutes
Architecture Documentation : ADRs, Tech Specs
- Architecture Decision Records (ADRs)
- System architecture diagrams (C4 model)
- Technology stack documentation
- Database schemas & data models
- Exercice : Créer ADR complet en 5 minutes
Code Documentation : Inline comments, README
- Generate docstrings (Python, JavaScript, Java)
- README.md comprehensive
- Code examples et tutorials
- Contribution guidelines
Module 3
Operational Documentation
Operational Documentation
Runbooks, SOPs) (30min
Leçons vidéo
Exercices
Lab pratique
Runbooks : Procédures opérationnelles
- Deployment procedures
- Incident response playbooks
- Disaster recovery procedures
- Maintenance checklists
- Exercice : Générer runbook deployment en 10 minutes
Standard Operating Procedures (SOPs) :
- Onboarding documentation
- Release management procedures
- Change management workflows
- Security policies
Troubleshooting Guides :
- Common errors & solutions
- Debug procedures
- FAQ techniques
Module 4
User Documentation
User Documentation
25min
Leçons vidéo
Exercices
Lab pratique
User Guides : End-user documentation
- Getting started guides
- Feature documentation
- Step-by-step tutorials
- Screenshots & annotations
- Exercice : Créer user guide complet en 15 minutes
Knowledge Base : FAQ, Help Center
- FAQ generation from support tickets
- Search-optimized articles
- Video scripts
Release Notes : Changelog automation
- Generate release notes from Git commits
- Feature highlights
- Bug fixes & improvements
- Migration guides