Fermer

Rédaction de la documentation

La rédaction du contenu structuré, convivial et efficace ... Celle-ci ne s'avère pas toujours évidente

Votre produit est-il presque prêt ? C’est bien beau, mais qu’en est-il de la rédaction de votre documentation ? Qui a du temps libre ? Y a-t-il quelqu’un parmi nous qui puisse assumer le rôle du rédacteur technique ? Qui sait documenter ce qui est important et automatiser ce qui peut l'être ? Tout en s’assurant que le langage et la structure soient clairs. Et en s’occupant de la mise en page et des illustrations en plus... Comment faire tout ça ?

Contactez-nous

Rédaction de la documentation

Cette situation vous est-elle familière ?

Rédiger des textes ? Bah, non merci ! | Oui, mais ça n’a pas l’air professionnel ! | Comment dois-je aborder cette tâche ?

Qui sait parler l’anglais ? Alors, faites de votre mieux ! | N’est-il pas possible d’automatiser ce truc ?

Comment nous pouvons vous aider.

Comment nous pouvons aider

À la recherche d’un rédacteur technique ?

Un rédacteur technique chez Flow prend soin de votre documentation technique et tout ce qui l’accompagne. Nous comptons de nombreuses années d’expérience dans toutes sortes de domaines et avec toutes sortes de technologies. Nous avons toujours hâte d’apprendre plus.

Un rédacteur technique de Flow sait aussi prendre en compte le contexte dans son ensemble. Quelles sont les meilleures méthodes pour gérer et transférer les savoirs et connaissances au sein de votre entreprise ? Comment faut-il réaliser concrètement la gestion de l’information ?

Il va de soi que nos rédacteurs sont passés maître dans le minimalisme, la rédaction structurée, l’architecture DITA et des sujets connexes. En tant que spécialistes de la communication technique, nous appliquons rigoureusement les guides de style et les meilleures pratiques de notre propre domaine de compétences. Nous sommes en outre bien au courant de tous les outils et logiciels fréquemment utilisés dans notre travail.

Documentation de L’API

Nous adoptons le point de vue d’un spécialiste en communication technique pour parcourir votre documentation sur l’API, la rendant accessible à vos clients ainsi que facile à gérer pour vous (grâce à la philosophie de ‘Docs as code’).

Flow optimise vos spécifications OpenAPI en coopération avec vos développeurs. Nous vous aidons s’il vous manque quelques pièces de documentation, comme des guides de démarrage et des guides pratiques. Nos spécialistes veillent à la cohérence de la forme et du contenu (p.ex. la question de terminologie). Profitez de meilleurs documents de référence rédigés en Markdown ou DITA qui facilitent la mise à jour de votre portail API.

Des documents API bien structurés permettent aussi la réutilisation de votre contenu.

Rédaction structurée

La rédaction structurée aide les rédacteurs à écrire de manière plus efficace et ciblée. Il est plus facile pour ceux qui utilisent des documents structurés de retrouver des informations pertinentes et claires.

La rédaction structurée est une technique de rédaction qui :

  • emploie des « blocs d’information » provenant d’un modèle d’information
  • suit des normes, règles et directives qui déterminent la structure de votre texte

La rédaction structurée peut s’imposer dans toutes sortes de textes. Elle n’est pas dépendante du logiciel dans lequel vous travaillez. Plus d’informations.

Types de documents

Nos experts sont à votre disposition pour vous aider à rédiger, organiser ou adapter toutes sortes de documents. Voici quelques exemples ci-dessous :

  • Domaine technique : modes d’emploi, instructions de travail, consignes de sécurité, instructions d’entretien, manuels d’installation ou de configuration
  • Sites Web : contenu web, pages intranet
  • Domaine d’affaires : présentations, notes de politique générale, plans d’affaires, définitions du produit, offres
  • Domaine de la formation professionnelle : animations, contenu d’apprentissage en ligne, syllabus, manuels de formation
  • Domaine de l’informatique (IT) : cas d’utilisation, spécifications, bases de connaissances wiki, aides en ligne

DITA (Darwin Information Typing Architecture)

L’architecture DITA est une norme d’OASIS internationale conçue pour structurer et publier des textes. Elle fonctionne comme ceci : on écrit de petits morceaux structurés (appelés rubriques ou « topics ») contenant de texte, des illustrations, des tableaux et éventuellement des vidéos. Ces rubriques sont stockées dans une base centrale, permettant aux rédacteurs de les gérer de façon centralisée et de les réutiliser sans modification dans différents documents et publications (l’édition à source unique ou « single source »). Tout est conservé dans un format de fichier universel (XML) qu’on peut ouvrir, modifier et publier avec une panoplie d’outils. Les rubriques DITA sont faciles à mettre à jour, à traduire et à publier sur différents supports comme des smartphones et des tablettes électroniques. Il existe un large éventail d’éditeurs pour travailler en DITA, tels que oXygen XML Author, FontoXML, XMetaL Author et Adobe FrameMaker avec DITA-FMx.

Canevas

Vous n’avez aucune idée comment il faut commencer la rédaction de ce plan de processus ? Ou s’agit-il plutôt de confusions et de malentendus parce que tout le monde fait les choses différemment ? Utilisez les canevas. Ils vous donnent une structure de base qui vous permet de concentrer exclusivement sur la rédaction du contenu et non sur la forme ou la structure.

Les canevas de Flow sont disponibles en plusieurs langues et peuvent être utilisés pour de nombreux types de documents.

Un regard neuf

La documentation est écrite par les experts, mais bien souvent les experts ne font pas partie du public cible de la documentation. Chez Flow, nous serons fréquemment les premiers « clients » réels de votre produit, service ou documentation. En jouant ce rôle, nous pouvons poser les bonnes questions :

  • Quelles informations faut-il encore ajouter pour votre client ?
  • À quel sujet votre client a-t-il encore des questions ?

Flow maintient ainsi un équilibre délicat entre expert et client.

Normes internationales

Votre documentation satisfait-elle aux normes et lois actuelles tels que l’ISO IEC 82079-1:2012 et la Directive machines ? Comptez-vous réorganiser votre documentation afin d’obtenir une certification ISO ? Nous vous donnons un coup de main en analysant votre documentation et en examinant les exigences nécessaires. Flow vous aide à convertir les documents existants de votre organisation afin de les rendre conforme aux normes ISO et à mettre en place un système pour créer des documents conformes d’emblée.

Interessé? Contactez-nous

Documents intéressants

Quelques références

Nos clients