Référence
Cette section sert de point d’entrée aux ressources de référence : inventaires d’API, clés de configuration, tableaux de compatibilité, comportement CSS pris en charge et registres de couverture entre packages.
Carte de référence
Section intitulée « Carte de référence »| Référence | Ce qu’elle permet de savoir |
|---|---|
| Matrice de prise en charge CSS | Quelles fonctionnalités CSS sont vérifiées, revendiquées, partiellement prises en charge ou non prises en charge dans le pipeline HTML. |
| Index de l’API Integrations | Quelle page de l’API d’extension couvre chaque framework, renderer, transport et surface d’outil de build. |
| Sections d’intégration | Où trouver la référence d’API et de configuration propre à chaque package. |
| Référence du module Core | Pages d’API et d’architecture au niveau du module, générées depuis le dépôt core. |
Contrat d’entrée de référence
Section intitulée « Contrat d’entrée de référence »Chaque entrée d’API doit répondre aux mêmes questions :
| Question | Réponse requise |
|---|---|
| Qu’est-ce que j’appelle ? | Symbole pleinement qualifié, endpoint, commande CLI ou clé de configuration. |
| Quelle entrée est acceptée ? | Tableau des paramètres avec type, caractère obligatoire, valeur par défaut et valeurs acceptées. |
| Que se passe-t-il par défaut ? | Le comportement lorsque l’entrée optionnelle est omise. |
| Qu’est-ce qui est renvoyé ? | Type de retour, corps de réponse, fichier de sortie, flux ou effet de bord. |
| Qu’est-ce qui peut échouer ? | Exception, erreur de validation, statut HTTP ou mode de défaillance opérationnel. |
| Comment l’utiliser en toute sécurité ? | Notes sur la sécurité, la sûreté des workers, les limites de taille, les chemins, les délais d’attente et la gestion des secrets. |
Politique de couverture
Section intitulée « Politique de couverture »Les pages de référence sont adossées au code source. Les API publiques sont documentées à partir du code source des packages, des fichiers de configuration, des tests et des exemples. Les classes d’aide internes ne sont documentées que lorsqu’un développeur d’application doit comprendre leur comportement pour configurer ou exploiter le package.
État de préparation à la traduction
Section intitulée « État de préparation à la traduction »Les pages de référence privilégient les tableaux plutôt que les paragraphes denses. Chaque ligne doit pouvoir être comprise seule, car la segmentation XLIFF ultérieure découpera le contenu par bloc.