> ## Documentation Index
> Fetch the complete documentation index at: https://stix.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 16. Comment garder une documentation propre et cohérente

# Comment garder une documentation propre et cohérente

### Les bonnes pratiques pour maintenir un site clair et agréable à lire

## Pourquoi maintenir une documentation propre ?

Une documentation n’est jamais “terminée”.

Elle évolue avec le temps, les nouvelles pages, les corrections et les mises à jour.

Garder une documentation propre permet :

* d’éviter les doublons

* de garder une navigation claire

* de faciliter la lecture

* d’améliorer l’expérience utilisateur

Une documentation bien entretenue inspire confiance.

## Vérifier régulièrement la structure

Pour garder un site cohérent :

* relisez la sidebar une fois par semaine

* vérifiez que les pages sont bien classées

* supprimez les pages inutiles

* renommez les titres trop longs ou confus

Une bonne structure est la base d’une documentation professionnelle.

## Harmoniser les titres et les sections

Pour une cohérence visuelle :

* utilisez le même style de titres partout

* évitez les variations inutiles

* gardez une logique de progression

* utilisez des titres courts et explicites

Une documentation harmonisée est plus agréable à parcourir.

## Mettre à jour les pages existantes

Une documentation propre n’est pas seulement une question d’organisation.

Il faut aussi :

* corriger les pages obsolètes

* mettre à jour les exemples

* vérifier les liens internes

* supprimer les informations dépassées

Une documentation vivante reste utile plus longtemps.

## Vérifier les liens et les images

Une fois par mois :

* testez les liens internes

* testez les liens externes

* vérifiez que les images s’affichent

* supprimez les images inutilisées

Les liens cassés donnent une mauvaise impression.

## Conseils pratiques

* gardez un style d’écriture simple et cohérent

* évitez les pages trop longues

* séparez les sujets complexes en plusieurs pages

* utilisez les blocs Mintlify pour clarifier

* testez régulièrement votre site sur Vercel

Une documentation propre est une documentation entretenue.

## Résumé

Garder une documentation propre consiste à vérifier régulièrement la structure, harmoniser les titres, mettre à jour les pages et tester les liens.

Une maintenance régulière garantit une documentation claire, cohérente et agréable à lire.

## Pour aller plus loin

* Documentation Mintlify : [https://mintlify.com/docs](https://mintlify.com/docs)

* Bonnes pratiques UX : [https://developer.mozilla.org](https://developer.mozilla.org)
