any2.video vs le recrutement d'un rédacteur technique : deux réponses au même problème de couverture
Un bon rédacteur technique est l'un des recrutements à plus fort effet de levier qu'un éditeur de logiciels puisse faire, et rien ici ne va à l'encontre d'un tel recrutement. La documentation écrite et la vidéo vérifiée répondent à deux moitiés différentes du problème de couverture, et choisir entre elles revient en réalité à se demander quelle moitié est aujourd'hui défaillante.
Ce que prouve chaque option
| Question | Rédacteur technique | any2.video |
|---|---|---|
| Ce qui est produit | Du texte qui se prête à la recherche, aux liens et aux corrections. | Un enregistrement de la tâche qui aboutit, accompagné d'un guide écrit. |
| Répond à « où est le bouton » | Avec des mots, que le lecteur doit faire correspondre à l'écran. | En le montrant. |
| Répond à « pourquoi cela existe » | Très bien. C'est la vocation même du texte. | Mal. La vidéo est peu adaptée aux contenus de référence. |
| Vitesse de couverture | Rapide pour le texte, lente pour tout ce qui exige une capture d'écran. | Deux jours par tâche, par lots. |
| Où le trouver | Votre site de documentation, et les moteurs de recherche. | YouTube et les assistants IA, là où se posent les questions sur les produits. |
| Rester à jour | Dépend de la discipline et du processus de relecture. | Une étiquette de version et une réexécution déclenchée à chaque nouvelle version. |
Quand un rédacteur technique est le bon choix
- Votre documentation est incomplète, contradictoire ou délaissée. Corrigez cela d'abord. Ajouter une vidéo à une mauvaise documentation ne fait que propager l'erreur.
- Le contenu relève de la documentation de référence : paramètres, surfaces d'API, limites, explications conceptuelles.
- Les lecteurs ont besoin de chercher, de copier et de créer des liens. Personne ne copie une commande depuis une vidéo.
- Il vous faut ce contenu intégré au processus de publication des versions, et non à côté.
Quand ce n'est pas le cas
- L'étape écrite existe et les utilisateurs se trompent quand même, ce qui signifie généralement que l'écran ne ressemble pas à la phrase.
- La question est « est-ce que ça marche vraiment », ce qu'un texte ne peut pas trancher, contrairement à des preuves à l'écran.
- Vos acheteurs se forgent une opinion sur YouTube, où votre documentation n'apparaît pas.
- Le rédacteur que vous avez recruté passe sa semaine à faire des captures d'écran au lieu d'écrire.
Dans quel ordre procéder
La documentation d'abord. Si la procédure écrite est fausse, une vidéo de cette procédure est la même procédure fausse, en plus convaincant. Nous avons déjà refusé des missions pour cette raison, et nous le referions.
Une fois la documentation juste, ce qui manque n'est pas l'information, c'est la preuve et le repérage à l'écran. Un utilisateur qui a lu l'étape et ne trouve toujours pas l'option n'a pas besoin qu'on lui répète la phrase. Il a besoin de voir l'écran.
Chaque pas-à-pas est livré avec du texte
C'est pourquoi le guide écrit et les notes de dépannage sont inclus plutôt que vendus en option. Chaque exécution vérifiée produit les étapes exactes qui ont fonctionné, dans l'ordre, avec les tentatives qui ont échoué et leurs solutions. Ce résultat est souvent meilleur que ce qui figurait dans la documentation, parce qu'il provient d'une exécution et non de la mémoire, et votre rédacteur peut le reprendre directement dans la documentation.
Ce qu'un rédacteur y gagne
La capture d'écran est ce qu'un rédacteur technique fait de moins précieux, et elle dévore sa semaine. Une exécution vérifiée lui remet un journal horodaté de ce qui s'est réellement passé, c'est-à-dire la matière première qu'il allait devoir reconstituer à la main.
Questions
Devrions-nous recruter un rédacteur technique ou acheter de la vidéo ?
Si la documentation est fausse ou absente, recrutez d'abord le rédacteur. Une vidéo construite sur une documentation inexacte multiplie l'erreur. Si la documentation est solide et que les utilisateurs restent bloqués, ce qui manque est la preuve plutôt que l'information, et c'est ce qu'apporte un pas-à-pas vérifié.
La vidéo remplace-t-elle notre documentation ?
Non, et elle ne le devrait pas. Le texte se prête à la recherche, se copie et se corrige à moindre coût. La vidéo est peu adaptée aux contenus de référence, mais efficace pour montrer une tâche qui aboutit.
Recevons-nous quelque chose que notre rédacteur puisse utiliser ?
Oui. Chaque pas-à-pas est livré avec les étapes exactes qui ont fonctionné et les tentatives qui ont échoué, générées à partir du journal d'exécution. La plupart des équipes les collent directement dans leur documentation.
Le moyen le plus rapide de trancher : une tâche, réalisée des deux façons. La première vidéo d'essai est gratuite.
$ get-sample → $ cd /library