Guide Cortex Docs : une spécification, deux livrables qui doivent garder l’unité
Une spécification fictive et deux sorties papier montrent si valeur, unité et champ vide gardent leur sens.
Une seule spécification peut réduire la double maintenance de la documentation et de la référence de développement, sans garantir que des sorties semblables disent la même chose. En septembre 2026, Cortex Docs a présenté la génération de documentation consultable et de SDK typés. Nous vérifions seulement le sens visible, sans code, utilisation de SDK ni génération réelle.
Comparer chaque sortie à une fiche de spécification
L’unité de largeur est la case de grille. « 0 » signifie aucune largeur ; un champ vide reste non confirmé et ne vaut pas 0. Le document A précise les trois points. La référence B dit « Largeur : nombre, 0 par défaut », sans unité. Donnez à deux lecteurs la même fiche vide, avec un seul modèle chacun. Demandez si le champ vide vaut 0 et l’unité de « 2 ».
Pour A, les réponses sont « non confirmé, pas 0 » et « 2 unités de grille ». B omet l’unité et modifie le sens du blanc. Supprimer « 0 par défaut » sans ajouter l’unité ne corrige que la moitié. Vérifiez séparément unité, zéro explicite et champ vide dans la spécification. Le mot « largeur » ne suffit pas. Les modèles sont inventés, sans accès à une interface, à un projet ou à de vrais fichiers.
Clarifier la règle avant d’ajouter une sortie
Si l’équipe maintient régulièrement une documentation consultable et une référence de développement, la spécification commune de Cortex Docs mérite d’être comparée. Pour une page interne, le tableau d’origine demande moins d’entretien. Définissez d’abord l’unité et le sens du blanc ; un livrable ne transforme pas une omission en fait. Cet exercice ne vérifie ni génération, ni comportement, ni compatibilité, ni exactitude.
À propos de cet article :Cet article s’appuie sur des informations publiques et sert de référence pour vous aider à choisir vos outils. Les fonctionnalités, les tarifs et les politiques associées peuvent évoluer à tout moment ; veuillez consulter les informations officielles les plus récentes.
Source originale :www.producthunt.com