Rubriques
Outils d’IA
Utilisez des outils d’IA pour accélérer votre flux de travail de documentation.- Automate documentation updates : tutoriel qui explique comment configurer des mises à jour automatisées de la documentation à l’aide de l’agent.
- Build an in-app assistant : tutoriel qui explique comment ajouter un chatbot IA dans une application React pour aider les utilisateurs à trouver des réponses dans votre documentation.
- Claude Code, Cursor, Windsurf : guides pour utiliser des assistants de programmation IA afin de maintenir la documentation.
- GEO : bonnes pratiques pour optimiser votre documentation pour les moteurs de recherche et de réponse basés sur l’IA.
Documentation d’API
Créez une documentation d’API qui permet aux utilisateurs de tester et d’apprendre à utiliser votre API, tout en étant facile à maintenir.- Migrer de MDX vers OAS: Migrez votre documentation d’API depuis des pages MDX individuelles vers des pages générées automatiquement à partir d’une spécification OpenAPI.
Bonnes pratiques
- Accessibilité: Rendez votre documentation accessible au plus grand nombre possible.
- Types de contenu: Choisissez le bon format pour les tutoriels, guides pratiques, références et explications.
- Améliorer votre documentation: Utilisez les données et les retours pour améliorer continuellement votre documentation.
- Maintenance: Gardez votre documentation précise et à jour.
- Médias: Ajoutez des images, des vidéos et d’autres médias de manière efficace tout en maîtrisant la charge de maintenance.
- Organiser la navigation: Concevez une architecture de l’information adaptée à vos utilisateurs.
- SEO: Optimisez votre documentation pour les moteurs de recherche.
- Style et ton: Écrivez avec un ton cohérent.
- Comprendre votre audience: Étudiez les besoins et objectifs de vos utilisateurs et répondez-y.
Flux de travail Git
- Concepts de Git : Apprenez les fondamentaux de Git pour la documentation.
- Branches : Utilisez des branches pour gérer les modifications de la documentation.
Cas d’utilisation
- Créer une base de connaissances : configurez une base de connaissances interne pour centraliser les informations de votre équipe, améliorer la recherche et réduire la charge de maintenance.
Par où commencer
Vous débutez avec la documentation ?
Découvrez les types de contenu pour comprendre comment structurer votre documentation.
Vous améliorez une documentation existante ?
Découvrez comment utiliser les indicateurs et les retours pour améliorer votre documentation.
Vous configurez des fonctionnalités d’IA ?
Automatisez les mises à jour de la documentation avec l’agent.
Vous travaillez en équipe ?
Apprenez les workflows Git pour une documentation collaborative.