Les 7 piliers de la documentation

A mesure que la technologie évolue, les choix pour des outils efficaces de documentation structurée s’élargissent. Ce qui était autrefois une niche est devenu un éventail étourdissant de solutions. Il existe différentes technologies, telles que DITA et XML, des plates-formes avec beaucoup d’options, et de fonctionnalités utiles ou non. Si vous ne faites que commencer votre recherche d’un nouvel outil, ou même si vous faites vos sélections, assurez-vous que la solution que vous choisissez est la mieux adaptée aux besoins de vos rédacteurs et de votre organisation. Et n’oubliez pas vos utilisateurs. Voici 7 choses à rechercher :

  • Importation de contenu existant : Si vous n’avez jamais travaillé avec un système de documentation modulaire, il est tout à fait possible que votre contenu existant soit un format de publication Word ou desktop. Bien que la plupart des solutions vous diront que l’importation de Word est une option, elle est souvent très difficile, surtout si vous convertissez des documents Word en DITA ou XML. Avant de décider, considérez la solution la plus viable pour votre équipe. Avec Author-it, par exemple, l’importation de Word est un processus simple où votre contenu est décomposé en composants et stocké dans un véritable CCMS pour réutilisation, traduction et plus encore.
  • Interface facile à utiliser : Les rédacteurs ont déjà un gros travail. Ajouter de la complexité à l’expérience utilisateur est la dernière chose dont ils ont besoin. Assurez-vous de sélectionner un produit qui est non seulement facile pour les rédacteurs techniques, mais aussi pour les contributeurs qui n’ont peut-être pas la possibilité d’utiliser du code.
  • Collaboration & Examen : La possibilité de collaborer et d’examiner les commentaires et les modifications suggérées à votre contenu en temps réel est un avantage majeur. Surtout dans des moments comme où les équipes de rédacteur diminuent et où le besoin de contributions directes des PME et des rédacteurs non techniques est crucial. Avec Author-it, le module de collaboration et d’examen a été construit autour de ce besoin, afin que les rédacteurs techniques puissent travailler avec des experts externes en toute sécurité et avec une interface qui permet aux contributeurs d’écrire librement, et d’éviter les goulots d’étranglement en fin de projet.
  • Les capacités techniques de vos contributeurs : Une nouvelle tendance dans la création de modules a vu le jour, y compris des rédacteurs non techniques et des experts produit. Lorsque vous permettez aux contributeurs d’écrire et d’examiner du contenu, vous pouvez gagner du temps et éviter le jeu frustrant « dépêchez-vous et attendez » des anciens processus d’examen. Cependant, la plupart des PME et des rédacteurs non techniques n’ont pas l’expérience, ou la bande passante, pour apprendre des compétences techniques d’écriture et plus particulièrement, comment écrire dans les modules. La facilité d’utilisation pour les contributeurs devrait être une priorité, car les obstacles techniques dus à la formation de personnes non techniques pour créer des composants est une énorme perte de temps, et forme un silo au sein de votre département. Les solutions basées sur XML et DITA sont construites par des personnes techniques pour les personnes techniques et toute l’expérience est dominée par la structure et le code. Cet environnement n’est pas le mieux adapté pour un contributeur dont l’expertise concerne le métier. Posez des questions aux fournisseurs sur la véritable facilité d’utilisation des contributeurs et demandez-vous si vous avez réellement besoin d’un outil basé sur XML ou DITA, ou s’il existe une meilleure solution pour votre équipe. La collaboration et l’examen en temps réel de l’auteur permettent aux PME de contribuer dans un format qu’elles connaissent bien, et la participation des contributeurs peut aider votre organisation à fournir à l’échelle du contenu critique d’entreprise avec un délai de mise sur le marché plus rapide tout en créant un environnement collaboratif qui évite les silos.
  • Un véritable CCMS : La plate-forme que vous avez choisie contient-elle un véritable système de gestion du contenu des composants (CCMS) ? Bien que certaines entreprises annoncent un CCMS intégré, elles sont souvent basées sur des fichiers, ce qui signifie qu’une seule personne peut y travailler à la fois et que le contenu est écrasé. Bien que les solutions DITA et XML soient CCMS, elles ne sont en fait qu’un référentiel de code. Un véritable CCMS, comme Author-it, est une base de données relationnelle dont le contenu est décomposé et stocké dans des composants. Cette architecture de base de données est facilement consultable et robuste en raison de la granularité du contenu géré, ce qui signifie que vous pouvez stocker et gérer facilement de grands volumes de contenu sans perdre le contrôle de votre documentation. Avec Author-it, vous pouvez gérer les composants, les workflows, la traduction et la localisation et plus encore dans notre CCMS intégré.
  • Publication de sorties : La publication multicanal est cruciale dans un outil de mise en forme, car les clients s’attendent à avoir des options pratiques pour la consommation de contenu. Être en mesure d’atteindre votre public où ils préfèrent apporte plus de sensibilisation à votre contenu et plus de commodité à vos clients. Lorsque vous magasinez pour créer des options de solution, assurez-vous de peser les avantages d’une solution de bout en bout, où vous pouvez créer du contenu une fois, le stocker dans un CCMS intégré et publier à n’importe quelle sortie, n’importe où, n’importe quand.
  • Un réel service associé : Un outil, même très performant ne saurait répondre aux exigences des utilisateurs s’il n’a pas été adapté à ses besoins spécifiques. Atelier numérique vous accompagne lors de la mise en place pour l’installation, pour la mise en place des circuits de travail et des formats de publication. L’application sera adaptée à votre contexte selon des critères ergonomiques et d’efficacité. L’équipe est disponible et s’adapte à vos exigences. Atelier numérique peut former les utilisateurs à Author-it. Atelier Numérique apporte des solutions créatives et sur-mesure.

Vous avez des questions ? Nous pouvons vous aider. Avec notre solution, vous pouvez créer, collaborer, gérer, traduire, réutiliser et publier du contenu. Le tout sur une plate-forme facile à utiliser.