Documentation du produit

Le service publie des guides pratiques pour les utilisateurs de l’application. Ouvrez Documentation pour préparer leur périmètre et suivre la rédaction.

Avant de commencer — Identifiez les utilisateurs et les tâches à expliquer. Préparez les prérequis réels, les libellés et les résultats attendus. Une capacité prévue doit être distinguée d’une action que les utilisateurs peuvent déjà réaliser.

Examiner les sections à rédiger

Comparez le contenu prévu à l’application réelle avant la rédaction des guides.

1. Ouvrez Documentation puis sa configuration.
2. Consultez Prise en main, Guides des modules et FAQ.
3. Examinez la définition et l’état des sections utiles à l’application.
4. Comparez les guides prévus aux tâches réellement disponibles.

Une référence API concerne un projet dont l’API existe et est active. Un endpoint prévu ne doit pas être présenté comme une intégration utilisable.

Apporter les informations manquantes

Fournissez la règle et le résultat demandés, au-delà d’une description générale de l’écran.

1. Retrouvez la section qui demande une précision.
2. Cliquez sur Répondre.
3. Décrivez la tâche, ses prérequis et le résultat à expliquer.
4. Cliquez sur Envoyer mes réponses et suivez l’état de la section ; vos réponses relancent son analyse.

Utilisez des exemples et les libellés réels. Le guide doit indiquer une action plutôt que seulement décrire l’écran.

Lancer la rédaction

Lancez la rédaction depuis l’aperçu prêt, puis suivez la demande et ses questions.

1. Revenez à l’aperçu de documentation.
2. Vérifiez que tous vos modules sont livrés ; d’ici là, le lancement reste indisponible.
3. Cliquez sur Lancer la rédaction de la documentation lorsqu’il est disponible.
4. Suivez Progression de la rédaction et les questions.

La demande démarre la rédaction. Attendez son avancement au lieu de multiplier les lancements.

Vérifier les guides publics

Suivez les instructions comme un utilisateur, avec le résultat final et la tâche suivante associée.

1. Ouvrez l’adresse du service de documentation.
2. Choisissez un sujet dans la navigation.
3. Suivez la procédure dans l’application réelle.
4. Vérifiez chaque langue publiée.
5. Ouvrez les articles liés pour contrôler les prochaines tâches proposées.

Le guide correspond à l’application, à sa langue et aux destinations utiles pour la suite.

Conseil — Revérifiez le guide après une évolution qui change tâche, libellé ou résultat. La traduction doit conserver toute la procédure, sans devenir un résumé plus court.

Un guide de compte doit préciser qui peut agir, l’environnement, les champs requis, la confirmation et l’état obtenu. « La page contient un formulaire » n’explique pas comment terminer la tâche ni reconnaître une erreur de validation.