Docs

Docs

À quoi sert cet écran

Docs est la documentation construite depuis vos dépôts et servie dans Fenwave, à côté du composant qu’elle décrit. Une documentation qui vit avec le code reste plus proche de la vérité qu’une documentation qui vit dans un wiki.

Les pages que vous lisez sont servies ainsi.

Avant de commencer

Pour faire ceci Il vous faut
Lire la documentation techdocs.read

La documentation d’un composant provient de son propre dépôt. S’il n’en a pas, l’onglet Docs est vide — un manque de contenu, pas une anomalie.

Ouvrir l’écran

  1. Explore › Docs dans la barre latérale pour l’ensemble.
  2. Ou ouvrez un composant dans le Catalogue et utilisez son onglet Docs.

URL directe : /docs

L’interface

📸 Capture d’écran : Une page de documentation ouverte dans le lecteur. Repères : (1) la liste des documentations, (2) la navigation interne, (3) le sélecteur de langue, (4) la recherche, (5) l’action de signalement.

# Élément Ce qu’il fait Quand l’utiliser
1 Liste des documentations Tous les composants documentés Parcourir
2 Navigation L’arborescence d’un jeu de documentation Lire
3 Sélecteur de langue Bascule entre français et anglais Toute documentation bilingue
4 Recherche Cherche dans la documentation Trouver une réponse précise
5 Signaler un problème Remonte une erreur sur la page Quand la documentation est fausse

Le sélecteur de langue mémorise votre choix et l’applique aux pages suivantes : vous le réglez une fois, pas à chaque page.

Procédures

Lire la documentation d’un composant

Ouvrez le composant dans le Catalogue et utilisez son onglet Docs. Ce chemin vous maintient dans le contexte ; passer par Explore › Docs vaut mieux quand vous ne savez pas encore quel composant vous cherchez.

Signaler une erreur

Utilisez l’action de signalement sur la page. Une documentation que personne ne corrige se dégrade jusqu’à ce que les gens apprennent à s’en méfier, et la correction coûte bien moins cher venant de la personne qui vient de buter dessus.

Scénario

La documentation dont vous avez besoin n’existe pas.

  1. Explore › Docs — confirmez qu’elle est réellement absente et non rangée à un endroit inattendu. Cherchez avant de conclure.
  2. Ouvrez le composant dans le Catalogue et vérifiez son onglet Docs. Vide ici signifie que le dépôt n’a pas de documentation.
  3. Trouvez le propriétaire sur la page d’entité. C’est lui qui peut l’ajouter.
  4. Si la documentation existe mais qu’elle est fausse plutôt qu’absente, utilisez plutôt le signalement : la demande est bien plus petite et bien plus susceptible d’aboutir.
  5. Si vous êtes propriétaire du composant, la documentation s’ajoute à son dépôt et se construit depuis là. Le lieu est l’essentiel : une page à côté du code est corrigée par celui qui modifie le code.

En cas de problème

Symptôme Cause Comment vérifier Solution
Docs n’est pas dans le sous-menu Il manque techdocs.read Access Explorer Demandez un rôle qui l’accorde
L’onglet Docs d’un composant est vide Son dépôt n’a pas de documentation Le dépôt Ajoutez de la documentation et laissez-la se construire
Changer de langue donne une 404 La page n’a pas d’équivalent dans cette langue L’arborescence de l’autre langue La page manquante doit être écrite
Une page est périmée La documentation est construite depuis le dépôt L’historique du fichier source Corrigez à la source, ou signalez le problème
La documentation manque après un changement La construction n’a pas eu lieu, ou a échoué — Attendez la prochaine construction ; vérifiez ensuite le pipeline

Pour aller plus loin