De quel logiciel avez-vous besoin pour créer le corps de la documentation en ligne de votre produit ? Il existe un large éventail d'outils professionnels qui répondent aux besoins de cette tâche spécifique. Cliquez sur Help.com est un exemple d'un tel logiciel (et plus encore, d'un environnement à part entière) dont vous avez besoin pour créer facilement une documentation en ligne.
Environnement de coworking
Il suffit d'installer OpenOffice.org ou l'une de ses nombreuses alternatives gratuites pour créer des documents seul sur votre machine locale. Mais lorsqu'il s'agit d'un énorme corpus de documentation technique pour un grand projet, il en faut bien plus. Même si vous ne gérez qu'un seul projet, tout d'abord, plusieurs rédacteurs et concepteurs sont responsables de diverses parties des documents. Deuxièmement, il y a des réviseurs et des éditeurs qui supervisent le travail des écrivains. Troisièmement, certains développeurs du logiciel lui-même doivent rester en contact avec le service de documentation. Si le projet est multilingue (ce qui est logique pour un produit global), des traducteurs sont également nécessaires. Enfin, il y a des managers qui contrôlent les processus.
Tous doivent se sentir à l'aise dans un environnement cloud unifié. Différentes fonctionnalités peuvent transformer un service cloud avec stockage et éditeur en ce type d'environnement :
- Un messager intégré. Tout le monde doit rester connecté. Avec un tel messager, vous pouvez envoyer des liens internes, des captures d'écran, des événements dans le calendrier de l'entreprise, etc. Les données que vous envoyez restent sécurisées.
- Outils de planification. Vous devez nommer des événements, attribuer des tâches, surveiller leur statut, fixer des délais, réattribuer des tâches à d'autres spécialistes (si nécessaire), vérifier leur niveau d'occupation, etc.
- Flux de travail personnalisable. Il peut y avoir différentes tâches qui nécessitent différentes équipes et diverses approches.
Il est également important de rendre ce service multiplateforme, surtout à l'ère du confinement où tout se passe à distance. Non seulement les employés apportent désormais leurs propres appareils : ils travaillent à domicile avec tout ce qu'ils ont ou jugent nécessaire. Les outils en ligne doivent donc être accessibles via tous les navigateurs les plus populaires pour Windows, Mac ou Linux. Il peut y avoir une application mobile qui combine un messager, un calendrier, un éditeur personnalisable et tout ce qui est nécessaire.
Éditeurs configurables
Lorsqu'il s'agit de documentation en ligne pour les logiciels, les lignes directrices émergent inévitablement qui définissent le résultat. Certains d'entre eux sont dictés par la convivialité pure, d'autres proviennent des fonctionnalités spécifiques du logiciel et il est parfois nécessaire de conserver les documents conçus dans le style de votre entreprise. Afin de rendre votre documentation plus simple et plus rapide, vous ne pouvez opter que pour les outils dont vous avez besoin pour la réaliser.
Que pouvez-vous vous débarrasser des éditeurs ? Certaines options de formatage et polices peuvent être superflues. Les fonctionnalités les plus nécessaires peuvent être mises en avant des autres, elles sont donc les plus faciles d'accès. Les polices apparaissent par ordre de fréquence, donc les plus demandées viennent en premier. Vous devrez peut-être passer en mode code ou vous sentir bien avec un éditeur purement visuel. Enfin, vous pouvez créer différentes versions de l'éditeur, selon le poste. Les rédacteurs techniques, par exemple, n'accèdent qu'à la version de base, tandis que les éditeurs et les gestionnaires peuvent rédiger des pages avec un plus grand nombre d'outils.
Gabarits
Vous pouvez envisager de concevoir des documents à partir de zéro. Néanmoins, les modèles peuvent économiser des milliers d'heures du seul fait qu'ils existent. Un bon modèle peut nécessiter très peu de modifications pour répondre à vos besoins et ressembler à ce que vous souhaitez. Bien sûr, la documentation est avant tout fonctionnelle, avec peu d'espace pour les expérimentations des concepteurs. Pourtant, il y a suffisamment de degrés de liberté.
Non seulement il peut y avoir des modèles pour les pages du portail de documentation. Il peut y avoir des configurations d'éditeur, des modèles de workflow, etc. Tout ce qui est personnalisable est meilleur avec quelques exemples.
Les modèles, en fait, ne sont qu'une partie d'une structure à plusieurs niveaux. Si vous souhaitez créer votre documentation rapidement, vous devez pouvoir le faire en quelques minutes avec des modèles, des outils d'importation et des éditeurs rapides. Mais si vous souhaitez le personnaliser plus profondément, vous aurez peut-être besoin d'outils plus professionnels, vous permettant de modifier et d'ajuster à la fois le contenu et la convivialité.
Convivialité finale
Il est important de faciliter la création de la documentation. Mais il est crucial de rendre la documentation prête à l'emploi facile à utiliser par les clients. Ainsi, le logiciel (ou plutôt le service) que vous utilisez doit prendre en charge des fonctionnalités qui améliorent la convivialité. Ils peuvent inclure :
- Hébergement de votre documentation. Inutile de dire qu'il devrait offrir suffisamment d'espace et une intégration confortable dans votre site Web principal.
- Chat en direct. Si un client a une question à poser, il doit pouvoir la poser directement depuis la page où elle est apparue ou depuis la plus pertinente.
- Alertes. Lorsque la nouvelle version arrive, vous devez en informer les clients.
- Exportabilité. La documentation en ligne est excellente, mais si votre client souhaite avoir une copie locale, il doit pouvoir télécharger une version CHM, un fichier PDF ou une aide Web à héberger sur votre propre serveur.
- Intégration de services tiers. Si vous envisagez de vendre votre produit dans le monde entier, vous pouvez intégrer la traduction automatique. Si des commentaires sont prévus, vous pouvez ajouter Disqus ou d'autres plateformes de commentaires tierces.
Prix
Difficile de trouver quelque chose de mieux adapté au modèle SaaS qu'un logiciel de création de documentation en ligne. Basé sur le cloud par définition, il offre plus que de simples outils de création de documents. Les éditeurs offrent des avantages tels qu'un messager intégré, des outils de gestion, un stockage en nuage pour les documents, etc. Pas étonnant que sa maintenance fasse de l'abonnement l'option la plus logique.
Pourtant, il existe diverses options de paiement, non seulement en termes de montants mais également de flexibilité. Vous pouvez économiser davantage si vous vous abonnez uniquement aux fonctionnalités dont vous avez réellement besoin.
Docs
La documentation en ligne est plus efficace que les documents statiques locaux, mais sa création et sa maintenance nécessitent plus d'efforts. Pas étonnant que les outils pour cela soient également spéciaux. Mais plus vous visualisez clairement l'image de votre futur portail de documentation, plus il vous sera facile de trouver le logiciel adéquat pour le développer et le maintenir au fur et à mesure de l'évolution de votre produit. Dans toute la variété des logiciels de création de documentation, il existe un outil pour vous.
