Création du contenu
Le rédacteur technique crée le contenu du projet de rédaction technique dans un dialogue constant avec les différents acteurs de la société : services R&D, marketing.
Définition
Section intitulée « Définition »Le rédacteur technique crée le contenu du projet de rédaction technique dans un dialogue constant avec les différents acteurs de la société : services R&D, marketing. Il prend en compte en amont les différentes contraintes liées au cycle de vie des supports de rédaction technique.
Principes clés
Section intitulée « Principes clés »En particulier, le rédacteur technique a soin de :
- faire valider le contenu à ses interlocuteurs afin d’apporter les modifications nécessaires aussi tôt que possible ; ceci garantit que le résultat sera conforme au projet initialement défini,
- minimiser le volume de texte et d’images sources afin de réduire les coûts de production, de maintenance et de traduction,
- prendre en compte dès le début du projet les contraintes d’internationalisation.
Dans un workflow docs-as-code
Section intitulée « Dans un workflow docs-as-code »Lorsque les sources sont des fichiers texte sous Gestion de versionsEnregistrement de chaque modification d'un ensemble de fichiers, qui permet de restaurer n'importe quel état antérieur, de comparer les changements et de travailler à plusieurs en parallèle. Git est le logiciel de gestion de versions le plus répandu ; en docs-as-code, la documentation est placée sous gestion de versions à côté du code du produit.Voir dans le glossaire →, le contenu est rédigé dans une BrancheLigne de travail parallèle dans un système de gestion de versions : les modifications faites sur une branche restent isolées jusqu'à leur relecture et leur fusion dans la ligne principale, ce qui permet de faire avancer en même temps plusieurs rédacteurs, versions ou langues.Voir dans le glossaire → puis soumis sous forme de Pull requestDemande d'intégration des modifications d'une branche dans la ligne principale, présentée sous forme de différences à relire : les relecteurs commentent, les contrôles automatisés s'exécutent et l'approbation est tracée avant la publication. GitLab parle de merge request.Voir dans le glossaire → : la validation au plus tôt décrite ci-dessus fait alors partie du flux normal au lieu d’être une étape à part. Structurer chaque page selon son type d’information (Concept, tâche, référenceLes trois types d'information de base de DITA XML : un concept introduit ou explique une idée, une tâche est une procédure numérotée, une référence est un contenu de consultation comme une liste de paramètres. Les articles de ce manuel sont eux-mêmes étiquetés selon ces trois types.Voir dans le glossaire →) et partir des modèles correspondants préserve la modularité et la Réutilisation du contenu (réutilisation de contenu)Rédiger une information une seule fois et l'employer à plusieurs endroits ou dans plusieurs livrables plutôt que de la recopier : une correction faite une fois s'applique partout. Les conrefs, le texte conditionnel et le single-sourcing sont autant de moyens d'y parvenir.Voir dans le glossaire →.
Les assistants IA peuvent accélérer un premier jet, une reformulation ou la reprise de contenus existants. Ils ne dispensent pas le rédacteur technique de sa responsabilité quant à l’exactitude : le texte généré doit être vérifié sur le produit lui-même (voir tester les produits pour les documenter) et passer par la même validation que toute autre contribution.