Garde votre documentation synchronisée avec votre code
Une documentation obsolète est pire que pas de documentation — elle induit activement en erreur. Le Réviseur de Documentation détecte quand les changements de code rendent la documentation incorrecte.
Les bugs silencieux — la documentation qui ment
Des docs qui décrivent d'anciens comportements — le type de documentation le plus dangereux
Fonctions publiques et endpoints sans documentation appropriée
Des commentaires qui disent une chose alors que le code en fait une autre — pire que pas de commentaires
Docs d'API qui ne correspondent pas aux endpoints réels — cause #1 des échecs d'intégration
Documentation Storybook et composants qui ne reflète pas les changements de props
Types TypeDoc/JSDoc qui mentent sur les interfaces et signatures réelles
Chaque endroit où les docs et le code peuvent se désynchroniser
Documentation des fonctions et méthodes
Aperçus des projets et packages
Explications du code et TODOs
Descriptions et exemples d'endpoints
Commentaires d'interfaces et types
Précision de l'historique des versions
Comme la dette technique, la dette de documentation s'accumule silencieusement. Nous donnons à votre codebase un Score de Santé de Documentation — un seul chiffre qui montre à quel point vos docs ont dérivé de la réalité.
README.md
Dernière mise à jour il y a 45 jours, code modifié 12 fois
src/api/
3 endpoints non documentés
CHANGELOG.md
Entrées manquantes pour v2.3.0, v2.3.1
src/utils/
8 fonctions exportées sans JSDoc
Pas seulement des vérifications génériques de docs — nous comprenons les patterns de documentation de votre framework
Pour la fonction processPayment(amount, currency, options):
/**
* Traite une transaction de paiement
* @param amount - Montant en centimes (entier)
* @param currency - Code devise ISO 4217
* @param options - Options de traitement
* @param options.idempotencyKey - Clé unique
* @param options.metadata - Paires clé-valeur personnalisées
* @returns Promise<PaymentResult>
* @throws PaymentError si refusé
*/Quand nous trouvons de la documentation manquante ou obsolète, nous ne faisons pas que le signaler — nous générons la correction. L'IA analyse vos signatures de fonctions, types de retour et patterns d'utilisation pour suggérer une documentation précise.
Crée la documentation à partir des signatures de fonctions et types
Met à jour la documentation obsolète pour correspondre au code actuel
Exemples réels de documentation qui nécessitait une mise à jour
/**
* Fetches user by ID
* @param id - User ID
* @param includeDeleted - Include soft-deleted users
*/
async function getUser(id: string, options?: GetUserOptions) {
// includeDeleted moved to options object 3 months ago
// but JSDoc still shows old signature
}JSDoc montre l'ancienne signature avec paramètre positionnel
/**
* Fetches user by ID
* @param id - User ID
* @param options - Query options
* @param options.includeDeleted - Include soft-deleted users
* @param options.fields - Fields to select
*/
async function getUser(id: string, options?: GetUserOptions) {
// Documentation matches actual signature
}Mise à jour pour correspondre au pattern d'objet options actuel
// Retry 3 times with exponential backoff
async function fetchWithRetry(url: string) {
const MAX_RETRIES = 5 // Changed from 3
const response = await fetch(url)
// Actually no retry logic implemented anymore
return response
}Le commentaire décrit une logique de retry qui n'existe pas
// Simple fetch wrapper, no retry logic
// For retries, use fetchWithRetry from @/lib/http
async function simpleFetch(url: string) {
const response = await fetch(url)
return response
}Le commentaire reflète le comportement réel
## Installation
```bash
npm install
npm run setup # This script was removed
```
## Environment Variables
- `DATABASE_URL` - PostgreSQL connection
- `REDIS_URL` - Redis connection # We switched to in-memory cache
Le README référence un script supprimé et une ancienne config Redis
## Installation
```bash
npm install
```
## Environment Variables
- `DATABASE_URL` - PostgreSQL connection string
- `CACHE_TTL` - Cache duration in seconds (default: 3600)
La documentation reflète le processus de configuration actuel
Le Réviseur de Documentation ne vérifie pas seulement si la documentation existe — il vérifie qu'elle correspond à ce que le code fait réellement. Quand vous changez une signature de fonction, il signale le JSDoc.
Compare ce que disent les docs vs ce que fait le code
Remarque quand les changements de code invalident les docs voisines
Fournit du texte spécifique pour corriger la documentation
Comparer Code & Docs
Vérifie si la documentation correspond à l'implémentation réelle
Détecter les Changements
Identifie quand les modifications de code invalident les docs existantes
Signaler les Incohérences
Rapporte la documentation qui pourrait induire les développeurs en erreur
Suggérer des Mises à Jour
Fournit du texte spécifique pour mettre les docs à jour
Une mauvaise documentation coûte plus cher que pas de documentation
Une documentation précise signifie que les développeurs ne perdent pas des heures sur de fausses pistes
Les nouveaux développeurs peuvent faire confiance à ce qu'ils lisent au lieu de deviner
Les utilisateurs peuvent faire confiance à votre documentation d'API sans essais et erreurs
Chaque changement de code est une opportunité pour que les docs dérivent.
Le Réviseur de Documentation le détecte à chaque fois.
Ces problèmes passent inaperçus chaque jour — jusqu'à maintenant
des fichiers README sont obsolètes en 6 mois
des commentaires JSDoc ne correspondent pas aux signatures
temps moyen perdu à déboguer à cause de docs incorrectes
des docs d'API manquent au moins un champ requis
Laissez le Réviseur de Documentation détecter la dérive avant qu'elle n'induise en erreur. Gratuit pendant 14 jours, pas de carte de crédit requise.