Qu'est-ce que la rédaction technique

Cela fait cinq heures que vous passez à configurer votre site WordPress. Mais vous n'avez pas réussi à faire bouger les choses.

Quelques heures plus tard, fatigué, vous explorez au hasard la documentation WordPress, votre héros méconnu.

Vous avez consulté leur centre d'aide, lu les FAQ et les guides d'installation. Et voilà, dans les prochaines heures, vous avez publié un site WordPress de base.

Grâce à la documentation technique sur le site web. Cela vous a fait gagner du temps et vous a évité les maux de tête dans lesquels vous vous seriez noyé autrement.

Tout comme WordPress, presque tous les logiciels ont une documentation technique rédigée et publiée sur leur site web. Pourquoi ? Pour rendre l'expérience utilisateur plus fluide.

Dans cet article, nous allons tout partager sur la rédaction technique et sur la façon dont vous pouvez créer votre première documentation technique.

Commençons.

Qu'est-ce que la rédaction technique en réalité ?

La rédaction technique est une forme d'écriture spécialisée, centrée sur l'utilisateur, qui simplifie des sujets complexes et techniques en un langage facile à comprendre et à assimiler.

L'objectif de la rédaction technique est simple : amener les lecteurs à suivre les instructions.

Pensez aux manuels d'utilisation, aux guides d'installation d'une application ou d'un logiciel, aux spécifications de produits de logiciels techniques, aux procédures opérationnelles standard (POS), etc.

Par exemple, si vous voulez installer Microsoft Office sur votre système mais que vous n'avez pas d'instructions claires sur la façon de le faire.

Vous téléchargez le guide d'installation de Microsoft, qui détaille toutes les étapes nécessaires pour installer le logiciel sur votre ordinateur.

Il énumère toutes les étapes, du téléchargement du logiciel à son exécution et au suivi des instructions.

Types de rédaction technique

La rédaction technique se divise en cinq catégories différentes que vous devez connaître.

• Documentation pour l'utilisateur final : Elle informe l'utilisateur d'un produit sur les fonctionnalités de base du produit et sur la façon de résoudre les problèmes courants. Par exemple, les manuels d'utilisation, les guides d'installation, les centres d'aide, les FAQ et la base de connaissances.
• Rédaction de documentation de processus : Ce type de rédaction technique se concentre sur la normalisation des procédures au sein de l'entreprise et est conçu spécifiquement pour les équipes internes. Par exemple, les procédures opérationnelles standard (POS) et les wikis internes.
• Communication marketing technique : Elle exploite l'expertise technique et les stratégies de marketing pour transmettre la valeur de produits complexes. Par exemple, les études de cas, les pages de destination et les courriels commerciaux.
• Rédaction technique d'expert à expert : Elle est axée sur un créneau spécifique et fournit des informations riches en expertise aux personnes qui sont déjà des experts dans leur domaine. Le piège ? Ce type d'écriture ne peut être rédigé que par des rédacteurs techniques ou des personnes qui ont des connaissances spécialisées ou qui sont des experts dans leur domaine. Par exemple, les livres blancs et les résumés de recherche.
• Rapports techniques : Ce type d'écriture présente des informations détaillées sur les résultats de recherche, les résultats de projets ou les analyses techniques. Par exemple, les rapports de recherche, les rapports d'étape, les propositions techniques et les rapports de faisabilité.

À lire également : Qu'est-ce que la documentation d'ingénierie ?

Exemples de rédaction technique

Mais à quoi ressemble exactement la rédaction technique ? Examinons quelques exemples de rédaction technique pour mieux la comprendre.

Documentation produit

Une documentation produit fournit des informations détaillées sur les spécifications techniques du produit, ses fonctionnalités, des instructions étape par étape sur la façon de démarrer avec le produit et des manuels complets sur la façon d'utiliser le produit.

Elle comprend généralement les spécifications système pour que les utilisateurs puissent exécuter le logiciel, les instructions d'installation et d'utilisation, les FAQ ou une base de connaissances.

Agorapulse, par exemple, a une documentation produit propre et minimale sur son site web.

Lorsque vous cliquez sur le bloc spécifique, disons « démarrer », vous verrez les différentes questions hyperliées sur les conseils de dépannage et les informations spécifiques aux fonctionnalités.

À lire également : Le système de documentation qui alimente Agorapulse

Documentation API

La documentation API est un ensemble d'instructions expliquant comment les développeurs interagissent avec les applications logicielles. Cette documentation fournit des informations détaillées sur les points de terminaison de l'API, des exemples de code et des méthodes d'authentification.

Par exemple, la documentation de l'API Kit comprend un bref aperçu et des sections comme les changements, l'authentification, OAuth, les clés API et plus encore.

Procédures opérationnelles standard (POS)

Les POS sont comme un GPS pour les équipes : elles fournissent des instructions claires pour aider les membres de l'équipe à comprendre comment accomplir une tâche spécifique au sein d'une entreprise.

Voici un exemple de ce à quoi ressemble une POS d'intégration des employés :

Notes de version

Les notes de version informent les utilisateurs des nouvelles fonctionnalités du produit, des améliorations et des corrections de bogues dans les mises à jour logicielles.

Par exemple, Wix a publié les notes de version sur son site web. Chaque note de version a une date et est structurée brièvement en points. Le meilleur ? Chaque mise à jour est hyperliée à des instructions de documentation technique spécifiques.

Principes de la rédaction technique

Maintenant que vous connaissez les différentes variations de la rédaction technique, comprenons les cinq principes fondamentaux de la rédaction technique.

Chaque type de contenu est rédigé en fonction de ces principes.

Clarté et précision

Lorsqu'ils lisent de la documentation technique, les lecteurs ont un seul objectif : trouver et mettre en œuvre rapidement les informations.

Vous ne pouvez atteindre cet objectif pour les lecteurs qui lisent la documentation technique qu'en faisant une seule chose : écrire avec clarté et concision.

Et comment faire ?

• Gardez votre écriture claire et concise.
• Fournissez des définitions pour les termes techniques chaque fois que nécessaire
• Supprimez le jargon de votre écriture, les mots qui ont un impact sur la lisibilité tels que « juste », « que », « très », etc.

Voici un exemple de documentation technique mal rédigée.

Source de l'image

Voici à quoi cela ressemblerait si c'était amélioré pour plus de clarté :

Vous voyez la différence ? La lecture de la première documentation rend difficile pour le lecteur de comprendre l'information.

Mais la version améliorée ? Elle simplifie l'information et est rédigée en moins de mots et d'une manière que le lecteur peut absorber et mettre en œuvre.

C'est précisément ainsi que vous devez rédiger votre documentation pour plus de clarté.

Exhaustivité

Pour aider les lecteurs à atteindre leur objectif (dépanner un problème dans l'application ou construire le meuble à monter soi-même), vous devez inclure tous les détails pour aider les lecteurs à suivre les instructions étape par étape.

Cela signifie parsemer la documentation de tous les détails avec des diagrammes, des organigrammes, des visuels, du code et des vidéos pour simplifier l'information et la rendre exploitable pour le lecteur.

Comme ici, Storylane couvre chaque micro-étape pour aider les utilisateurs à démarrer et à créer leur première démo sur la plateforme.

Structure logique

Pour aider le lecteur à passer du point A au point B et à obtenir le résultat souhaité, vous devez bien structurer vos documents. Pensez à une série de sections significatives, de titres, de sous-titres et d'étapes d'instruction.

Comprenons mieux avec un exemple.

Un manuel d'utilisation commence par un guide de dépannage, puis passe aux instructions d'installation, suivi d'une section sur les fonctionnalités, et se termine par des termes de glossaire.

Vous voyez le problème ? Les utilisateurs vont lire des informations dont ils n'ont pas besoin pour le moment. Et l'information dont ils avaient besoin ? Cette information est enfouie sous des sujets avancés.

C'est pourquoi vous devez y réfléchir logiquement et rendre la documentation axée sur l'utilisateur en incluant l'information dans des séquences logiques.

Exactitude factuelle

Contrairement à d'autres formes d'écriture, où l'on peut ajouter des opinions personnelles, des anecdotes et des récits, la rédaction technique exige des faits, des connaissances et de la recherche.

La documentation technique doit se concentrer sur les faits et expliquer ce que fait un produit, à qui il est destiné et quelle est la proposition de valeur.

Par exemple, la documentation de Slack ne glorifie pas le fait qu'ils sont le meilleur outil de collaboration. Mais, elle s'introduit subtilement et passe directement à l'ordre du jour du document : comment démarrer avec Slack et les différents éléments que l'utilisateur verra en action dans l'outil.

Résolution de problèmes

Chaque documentation technique devrait avoir une destination : résoudre le problème de l'utilisateur.

Pour cela, vous devez d'abord identifier le problème que vous résolvez avec la documentation. Ensuite, écrivez la solution exacte qui les aiderait. Pour mieux expliquer la solution, vous pouvez également inclure des exemples, des captures d'écran annotées et des tutoriels vidéo.

Slite utilise un mélange de vidéos Loom et de captures d'écran de produits lorsqu'il donne des instructions spécifiques.

Dans leur section « Comment configurer votre espace de travail », par exemple, vous verrez que le document a répertorié toutes les fonctionnalités que l'utilisateur doit connaître. Pour plus de clarté, une capture d'écran du produit est ajoutée pour rendre les instructions plus claires à mettre en œuvre.

Le processus de rédaction technique

Le gros éléphant dans la pièce : comment *écrire* réellement une documentation technique ? La rédaction de documentation technique passe par différentes phases : la planification, la recherche, la rédaction et la révision, et enfin la publication.

Comprenons chaque phase en détail.

Phase 0 : Planification

Tout d'abord, sachez pour qui vous écrivez la documentation : développeurs, administrateurs système ou utilisateurs ? Maintenant, identifiez qui utilisera le document et quelles informations ils rechercheront.

Ensuite, posez-vous les questions suivantes :

• Quel est l'objectif n° 1 que les lecteurs veulent atteindre après avoir lu cette documentation ?
• Écrivez-vous pour des experts ou pour un public général ?
• Quelles informations cette documentation couvrira-t-elle ?

Phase 1 : Recherche

Enfin, recueillez les détails techniques nécessaires : spécifications du produit, documents de conception, documentation existante et informations provenant d'experts en la matière.

Créer un questionnaire

Décrire une nouvelle fonctionnalité de l'application ? Pour écrire à ce sujet, le rédacteur technique devra comprendre les tenants et les aboutissants de la fonctionnalité du produit.

Voici quelques questions qui pourraient être un excellent point de départ :

• S'agit-il d'une nouvelle fonctionnalité ou d'une version améliorée de l'ancienne fonctionnalité ?
• Que fait-elle et comment les utilisateurs peuvent-ils l'utiliser ?
• Quels sujets font référence à cette fonctionnalité ?
• Y a-t-il des notes/avertissements à inclure dans la description de la fonctionnalité ?
• Avez-vous besoin de captures d'écran, de gifs, de diagrammes ou de vidéos pour mieux présenter l'information ?

Identifier des sources crédibles

Trouvez les sources avec des informations factuellement exactes et à jour. Il existe deux sources crédibles que vous pouvez utiliser pour rédiger votre documentation :

Produit

Si vous rédigez une documentation sur une fonctionnalité, essayez la fonctionnalité vous-même et documentez le processus étape par étape.

De cette façon, vous obtenez une expérience de première main avec le produit et vous comprenez clairement comment le produit fonctionne, de l'étape 1 à l'étape N, ce qui vous aide à rédiger des instructions précises.

Experts en la matière (SME)

Interrogez les SME internes (experts des équipes de produits ou d'ingénierie) pour extraire des informations si vous écrivez explicitement sur le produit.

Cela vous aide à obtenir des informations directement de la personne qui a travaillé en étroite collaboration sur le produit, et elle aura des informations riches.

Source de l'image

Mais la vraie question pour les rédacteurs techniques est la suivante : « Comment interviewer les PME ? »

C'est simple. Posez aux PME des questions ouvertes spécifiques aux informations dont vous avez besoin. Disons que vous rédigez une documentation sur une fonctionnalité, vous pouvez poser des questions comme :

• Pouvez-vous me montrer le processus d'utilisation de cette fonctionnalité ?
• Avez-vous besoin d'autorisations élevées pendant cette étape ?
• Comment ce processus peut-il être identifié en cas d'échec, et comment peut-il être remonté ?

Capturez autant d'informations que possible auprès des PME en une seule entrevue. Mais si nécessaire, faites un suivi auprès des PME lors d'un autre appel et clarifiez vos doutes.

💡Conseil de pro :

• Utilisez des outils d'enregistrement vidéo pour enregistrer l'entrevue avec la PME, puis utilisez l'enregistrement pour rédiger votre documentation.
• Au lieu d'avoir toutes les recherches éparpillées sur Google Docs, utilisez des outils de collaboration documentaire comme Slite pour tout organiser au même endroit : vidéos enregistrées, liens de ressources, etc.

Phase 2 : Organisation du contenu

Vous avez terminé la recherche ? Organisez toutes les informations dans un document et rédigez le plan.

Pour ce faire, structurez votre documentation du point de vue de l'utilisateur : quelle est la première chose qu'il veut lire ?

Pensez-y et structurez vos titres et sous-titres en conséquence.

Par exemple, commencez par les informations générales, puis passez aux fonctionnalités spécialisées.

C'est exactement ce que la documentation de l'API de Reddit a fait. Elle couvre tous les éléments de l'API dans l'ensemble de la documentation.

Le document commence par des informations générales, puis se divise en fonctionnalités API spécifiques que les utilisateurs peuvent parcourir pour leurs besoins. Chaque fonctionnalité contient une description, une méthode, un exemple de code et des paramètres.

Compte tenu de la façon dont Reddit a rédigé sa documentation, vous pouvez créer un plan avec des titres et des sous-titres clairs. Voici un exemple de plan que vous pouvez utiliser pour commencer :

Phase 3 : Rédaction et édition

Maintenant que vous avez un plan structuré, il est temps de passer à l'étape suivante : la rédaction de la documentation technique. Comment s'y prendre ?

Commencez à remplir le plan avec les informations que vous avez recueillies au cours du processus de recherche.

Disons que vous travaillez sur la section « authentification » de l'exemple de plan. Vous ajouterez ici toutes les informations que vous avez recueillies lors de l'entrevue avec la PME.

Mais ce n'est pas tout pour rédiger votre documentation technique. Voici quelques façons de la faire ressortir :

• Couvrez les informations étape par étape : Développez chaque étape en détail afin que les utilisateurs sachent comment terminer chaque étape et passer à l'étape suivante sans faire d'erreur en suivant les instructions.
• Écrivez en utilisant un langage concis : Gardez le langage simple et concis sans ajouter trop de jargon technique (et non pertinent) et d'expressions complexes.
• Format pour la lisibilité : Assurez-vous de diviser le texte en paragraphes, de formater les liens et de bien démontrer l'information à l'aide d'éléments visuels tels que des vidéos, des captures d'écran et des GIF.

Une fois que vous avez rédigé votre première ébauche, il est temps de passer en revue les vérifications d'édition.

Lors de l'édition, concentrez-vous sur deux types d'édition :

Étape 1 : Édition de développement

L'édition de développement vise à rendre la documentation plus efficace tout en l'évaluant en fonction de l'information et de sa pertinence pour le public.

Alors, vérifiez l'ébauche pour la structure et le contenu et évaluez le flux logique des idées, la pertinence de l'information et l'alignement avec le public.

Étape 2 : Édition de ligne

Une fois que vous avez terminé les modifications de développement, il est temps d'affiner les phrases.

Pour ce faire, repérez la structure des phrases, le choix des mots, la cohérence narrative et la voix d'écriture. De plus, concentrez-vous sur le style d'écriture et la langue pour vous assurer que chaque phrase transmet l'information avec clarté.

Étape 3 : Révision

Maintenant, vérifiez l'exactitude technique de la documentation : fautes d'orthographe, ponctuation, vérification des faits et directives de style.

Vous voulez accélérer votre processus de révision ? Utilisez des outils comme Grammarly et Hemmingway.

Phase 4 : Examen et rétroaction

Une fois que vous avez rédigé et modifié le document, il est temps de l'envoyer aux PME pour obtenir leur rétroaction et apporter les modifications nécessaires. Comment ?

• Partagez l'ébauche dans un outil de collaboration documentaire comme Slite et invitez les PME à collaborer sur le document.
• Demandez aux PME de partager leur rétroaction sur des paramètres tels que l'expertise, les informations spécifiques à l'utilisateur qui ont été manquées et la pertinence de la documentation pour les utilisateurs.
• Les PME peuvent mettre en évidence les parties du document où elles aimeraient ajouter plus d'informations et ajouter leurs commentaires.

Au lieu des allers-retours pour contacter les PME et les appeler pour obtenir de la rétroaction et clarifier les points, cette forme de collaboration accélère le processus de rétroaction. Gagnant-gagnant pour les rédacteurs techniques et les PME.

Phase 5 : Publication et maintenance

Et voici la dernière étape après tout le travail acharné : la publication de votre documentation.

Pour cette dernière étape, choisissez la bonne plateforme de publication pour mettre votre documentation en ligne.

Voici cinq options parmi lesquelles vous pouvez choisir :

• Création du site Web de documentation
• Publication des documents sur GitHub
• Utilisation d'un outil de publication
• Partage via des dossiers infonuagiques
• Lancement d'une page de centre d'aide sur votre site Web

Parmi ceux-ci, l'utilisation d'un outil de publication et le lancement de la page du centre d'aide sont les meilleures façons de publier le document.

• Si vous voulez créer une documentation utilisateur, lancez la page du centre d'aide sur votre site Web.
• Si vous allez créer la documentation pour votre équipe interne, l'utilisation d'un outil de publication comme Slite est la meilleure : il vous permet même de vérifier la documentation et de tenir l'information à jour.

Outils pour accélérer votre processus de rédaction technique

• Plateforme de documentation : Organisez votre recherche : toutes les idées, le matériel que vous avez recueilli, les enregistrements vidéo et les transcriptions que vous avez capturés : dans un centre centralisé pour accéder à tout au même endroit. Il simplifie également le partage de l'information recueillie avec les intervenants et les PME avec lesquels le rédacteur technique collabore. Cet outil est parfait pour votre processus de recherche, de planification et de rédaction.

Exemple : Google Docs, Notion ou Slite.

• Outils de collaboration : Oubliez les allers-retours pour contacter les PME et attendre des jours pour obtenir leur approbation. Vous pouvez collaborer de façon asynchrone avec des outils de collaboration en envoyant des messages aux PME et aux intervenants. Cela fonctionne encore mieux si les outils de documentation ont des fonctionnalités de collaboration intégrées ou une intégration avec des plateformes de collaboration. Ces outils sont parfaits lorsque vous avez besoin de rétroaction sur la première ébauche des PME : vous pouvez leur poser des questions de suivi et clarifier les doutes sans quitter la documentation.

Exemple : Slite et Slack.

• Outil d'édition : Vous avez rédigé votre premier article de contenu technique ? Utilisez des outils d'édition pour accélérer votre processus d'édition pendant l'étape de l'édition de ligne et de la révision. Grâce à ces outils d'édition, vous pouvez modifier votre contenu pour les fautes d'orthographe, la ponctuation, la reformulation des phrases et la clarté.

Exemple : Grammarly, Hemmingway Editor ou Wordtune.

• Outil de conception : Une fois le contenu approuvé, l'étape suivante consiste à concevoir les éléments visuels. Avec les outils de conception, vous pouvez créer tous les éléments visuels que vous voulez inclure dans votre documentation : infographies, organigrammes et GIF. Ces outils ont également des modèles prédéfinis que vous pouvez utiliser au lieu de tout concevoir à partir de zéro.

Exemple : Canva pour la conception et Zight pour la capture d'écran et l'annotation des écrans de produits.

• Outil d'enregistrement vidéo et de transcription : Pendant le processus de recherche, lors de la collecte d'informations auprès des PME, les outils d'enregistrement vidéo et de transcription sont votre sauveur. Intégrez ces outils pendant l'appel ; ils enregistreront l'appel pour vous et fourniront même une transcription de l'appel entier. De cette façon, les rédacteurs techniques peuvent se concentrer sur l'écoute des informations de la PME sans être distraits.

Exemple : Zoom, Fireflies.ai ou Fathom.

• Outil de publication : C'est votre outil héros pour la publication et la maintenance du contenu, surtout si vous ne publiez pas le contenu technique sur votre site Web. Grâce à ces outils, vous pouvez publier du contenu et intégrer différents styles de formatage : tableaux, bases de données et contenu directement à partir d'autres outils. Plus important encore, vous serez en mesure de garder votre contenu frais et à jour sans le faire manuellement.

Exemple : Slite et Notion.

Meilleures pratiques pour rédiger votre première documentation technique

Tout est prêt pour rédiger votre première documentation technique ? Voici quelques bonnes pratiques que vous devez retenir :

1. Guides de style

Utilisez un guide de style pour améliorer les normes d'écriture et de formatage de vos documents techniques. Si vous n'avez jamais créé de guide de style auparavant, tenez compte de ces éléments :

• Ton et voix : Définissez le ton et la voix avec lesquels votre public résonne : formel, informel ou neutre.
• Grammaire et ponctuation : Fournissez des règles qui doivent être strictement utilisées et précisez l'utilisation de la ponctuation comme les traits d'union, les tirets cadratins, les points-virgules, la virgule d'Oxford et les points (à inclure ou non) dans les listes à puces et numérotées, et la capitalisation.
• Directives de formatage : Mentionnez les détails sur les polices, utilisez des listes à puces ou des listes numérotées (ou les deux), et utilisez des émojis et des styles de formatage : gras, italique et souligné.
• Terminologie et abréviations : Fournissez des directives sur la façon d'utiliser les terminologies. L'acronyme doit-il être mentionné à la fin de la terminologie seulement lorsqu'il est présenté la première fois, ou doit-il être mentionné chaque fois qu'il est mentionné dans le document ?
• Éléments visuels : Mettez en évidence les règles d'utilisation des éléments visuels dans le document. La documentation peut-elle inclure des organigrammes ? Ou doit-il s'agir spécifiquement de captures d'écran et de tutoriels de produits ? Lors de l'ajout de texte de remplacement et de légendes aux images, y a-t-il une façon précise de les rédiger ?

Par exemple, le guide de style d'écriture de Microsoft est rempli d'exemples utiles, y compris ce qui fonctionne et ce qui ne fonctionne pas.

Vous verrez les tableaux étiquetés avec des en-têtes comme « Utilisez ceci » et « Pas ceci » pour fournir des instructions claires, ce qui facilite la compréhension de l'information par les lecteurs en même temps. De plus, il mentionne clairement les scénarios où le rédacteur technique doit omettre les points, y compris la virgule d'Oxford, et ne pas inclure d'espaces autour des tirets cadratins.

1. Modèles de documentation

Au lieu de rédiger le contenu à partir de zéro, sans structure directionnelle, utilisez des modèles de documentation prédéfinis.

Vous ne travaillerez pas sur une toile vierge. Grâce à ces modèles, vous connaissez les sections exactes que votre documentation comprendra : cela vous fait gagner du temps et vous donne de la clarté sur la recherche que vous devez effectuer et les informations que vous devez extraire des PME.

Voici un exemple de modèle de documentation prédéfini :

À l'intérieur du modèle, vous obtenez les différentes sections que votre document devrait inclure et les détails que vous pouvez inclure en fonction de votre recherche.

1. Structure du contenu

Organisez votre documentation avec des titres clairs, des listes et des éléments visuels tels que des captures d'écran, des organigrammes et des tutoriels vidéo pour aider les lecteurs à digérer l'information rapidement et de manière simplifiée.

Jetez un coup d'œil à la documentation de l'API de Reply.io.

Chaque section est espacée avec différents titres, listes numérotées et listes à puces. Pour mettre l'accent sur quelques mots, ils les ont formatés en gras et ont fait un usage minimal des émojis. De plus, la documentation a l'air propre, avec l'espace blanc ajouté après chaque section.

1. Convention d'écriture

Au lieu d'un langage compliqué et fantaisiste, utilisez un langage simple et clair pour permettre aux lecteurs de comprendre facilement l'information technique complexe.

Concentrez-vous sur l'utilisation de la voix active et seulement 10 % de la voix passive. De plus, assurez-vous que vos phrases sont concises et sans remplissage, ce qui apporte de la clarté à votre documentation et simplifie la compréhension de l'information.

💡Conseil de pro : Vérifiez votre score de lisibilité sur Hemmingway : il devrait être de 9e année ou moins.

1. Assurance qualité

Avant de publier le contenu, demandez aux PME d'examiner le contenu pour en vérifier l'exactitude et la convivialité. Une fois le contenu publié, effectuez des vérifications régulières pour tenir le contenu à jour.

Par exemple, la documentation interne et les SOP que votre équipe utilise utilisent la fonctionnalité de vérification de documents de Slite pour demander aux PME de vérifier le document. Une fois le document vérifié, tous les membres de l'équipe savent que la documentation est exacte et prête à être utilisée.

Rédigez votre première documentation avec Slite

Soyons honnêtes : effectuer la recherche, collaborer avec les PME, obtenir de la rétroaction et maintenir la documentation publiée. C'est beaucoup de travail acharné.

Cela augmente la friction dans le processus de création de contenu. C'est là que vous avez besoin d'outils de documentation comme Slite qui deviennent le chevalier servant.

Avec Slite, vous pouvez :

Étape 1 : Capturez votre recherche : liens vers d'autres documentations pour référence, tutoriels vidéo ou captures d'écran que vous incluriez dans votre contenu ou l'enregistrement vidéo de la PME, et organisez-les dans votre canal Slack.

Étape 2 : Invitez les PME à l'espace de travail. Elles peuvent ajouter des commentaires au document de recherche et donner leur rétroaction, et même des ressources supplémentaires pour les rédacteurs techniques.

Étape 3 : Rédigez votre première documentation dans Slite ou intégrez l'outil à Google Docs, si c'est là qu'ils ont rédigé l'ébauche. Les PME peuvent examiner le document et ajouter des commentaires, et étiqueter les rédacteurs pour partager leur rétroaction.

Étape 4 : Demandez aux PME et aux intervenants de vérifier le document pour vous assurer que la documentation est exacte et à jour. Vous pouvez le faire avant de publier le document ou même après la publication de la documentation.

Vous voulez voir comment Slite peut stimuler la collaboration de votre équipe pendant le processus de création de contenu technique ? Essayez Slite gratuitement.