Plugin "Documentation des modèles"

Dans SPIP, les modèles permettent d’enrichir facilement les contenus éditoriaux en insérant des composants réutilisables dans les textes : images enrichies, encadrés, blocs interactifs, composants du design system, etc.

Mais à mesure que les projets grandissent, la liste des modèles disponibles peut devenir difficile à comprendre pour les rédacteurs ou les intégrateurs.

J’ai développé le plugin Documentation des modèles pour répondre à ce besoin : centraliser et générer automatiquement la documentation des modèles disponibles sur un site SPIP.

Le plugin permet notamment :

• de recenser automatiquement les modèles présents dans le site
• de produire une documentation claire et structurée
• de détailler les paramètres disponibles pour chaque modèle
• de faciliter la prise en main des modèles par les rédacteurs et intégrateurs

L’objectif est de rendre les modèles plus lisibles, plus accessibles et plus faciles à utiliser, en proposant une documentation directement intégrée au site.

Ce plugin est particulièrement utile dans les projets SPIP comportant de nombreux modèles personnalisés ou des composants issus d’un besoin particulier, où la documentation devient essentielle pour garantir une utilisation cohérente par les équipes éditoriales.

• Plugin SPIP : https://plugins.spip.net/modeles_doc.html?compatible_spip=4.4
• Documentation : https://contrib.spip.net/Documentation-des-modeles