À propos du service
TraduitJ'écris de la documentation technique et de l'aide produit que les gens lisent réellement : un guide utilisateur, un centre d'aide, une référence API. Le travail commence par démonter le produit. Je le parcours comme le ferait un nouvel utilisateur, note chaque endroit où je me suis bloqué et collecte les tâches réelles que vos utilisateurs apportent. La structure se développe à partir de ces tâches, et non de votre arbre de menu : d'abord le premier lancement et le premier petit succès, puis le travail quotidien, et seulement après cela les scénarios complexes dont peu de gens ont besoin mais qui prennent le plus de temps à l'équipe de support.
Chaque article est un ensemble d'étapes avec des captures d'écran, légendées de sorte que le lecteur n'ait jamais à deviner quel bouton est concerné. Une section distincte couvre les erreurs courantes et ce qu'il faut en faire : le texte à l'écran, la raison derrière, la solution. La partie API contient des exemples de requêtes et de réponses pour chaque méthode, explique les champs et les codes d'état, et indique clairement ce qui revient en cas d'échec. Un glossaire garde les termes du produit en un seul endroit, de sorte que l'interface, l'aide et les réponses du support utilisent les mêmes mots, et un court guide de style fixe le ton et la formulation, de sorte que le texte reste une seule voix même lorsque d'autres personnes y ajoutent plus tard.
Chaque instruction est vérifiée en parcourant les étapes sur le produit en direct ; rien écrit de la mémoire d'un développeur, sans cette vérification, ne va dans l'aide. Les clés, les jetons et les identifiants de test dans les exemples sont remplacés par des espaces réservés. La documentation pour une fonctionnalité inachevée est marquée comme un brouillon et n'est jamais présentée comme prête.
— parcours produit et liste des tâches réelles des utilisateurs
— structure d'aide du premier lancement aux scénarios avancés
— instructions étape par étape avec captures d'écran et légendes
— une section sur les erreurs courantes et ce qu'il faut en faire
— référence API avec des exemples de requêtes et de réponses
— glossaire des termes plus un court guide de style et de ton
— chaque instruction vérifiée à nouveau sur le produit en direct
— sources remises dans un format facile à éditer davantage
Chaque article est un ensemble d'étapes avec des captures d'écran, légendées de sorte que le lecteur n'ait jamais à deviner quel bouton est concerné. Une section distincte couvre les erreurs courantes et ce qu'il faut en faire : le texte à l'écran, la raison derrière, la solution. La partie API contient des exemples de requêtes et de réponses pour chaque méthode, explique les champs et les codes d'état, et indique clairement ce qui revient en cas d'échec. Un glossaire garde les termes du produit en un seul endroit, de sorte que l'interface, l'aide et les réponses du support utilisent les mêmes mots, et un court guide de style fixe le ton et la formulation, de sorte que le texte reste une seule voix même lorsque d'autres personnes y ajoutent plus tard.
Chaque instruction est vérifiée en parcourant les étapes sur le produit en direct ; rien écrit de la mémoire d'un développeur, sans cette vérification, ne va dans l'aide. Les clés, les jetons et les identifiants de test dans les exemples sont remplacés par des espaces réservés. La documentation pour une fonctionnalité inachevée est marquée comme un brouillon et n'est jamais présentée comme prête.
— parcours produit et liste des tâches réelles des utilisateurs
— structure d'aide du premier lancement aux scénarios avancés
— instructions étape par étape avec captures d'écran et légendes
— une section sur les erreurs courantes et ce qu'il faut en faire
— référence API avec des exemples de requêtes et de réponses
— glossaire des termes plus un court guide de style et de ton
— chaque instruction vérifiée à nouveau sur le produit en direct
— sources remises dans un format facile à éditer davantage
