JetBrains WriterSide : un outil pour écrire des documentations technique

Par:
fredericmazue

mar, 31/10/2023 - 14:07

Avec WriterSide, le célèbre éditeur Jetbrains entend proposer aux rédacteurs et développeurs un outil intégré à ces différents IDE pour écrire de la documentation technique, à l'aide d'un workflow d'écriture, de test et de construction.

L'outil met un place un pipeline 'doc as code'. Concrètement, sur la base d'outils de développement tels que Git, des revues pull et des contrôles automatisés, WriterSide permet à toute l'équipe de contribuer, de réviser et de suivre les modifications comme elle le fait avec le code. 

JetBrains souligne que WriterSide est construit par des documentaristes, pour des documentaristes. Ce projet s'est développé à partir de centaines d'entretiens clients et de plus de 10 ans de travail sur la documentation de la plateforme IntelliJ. Ces expériences nous ont donné une longue liste de fonctionnalités à construire et de problèmes à résoudre, précise encore JetBrains

WriterSide prend en charge à la fois Markdown et un balisage personnalisé basé sur XML et permet de combiner les deux formats dans le même document. WriterSide veut garantir la qualité et l'intégrité de la documentation avec plus de 100 inspections à la volée dans l'éditeur ainsi que des tests dans la prévisualisation et pendant la construction. Il dispose d'une fonctionnalité d'aperçu qui montre les documents exactement tels les lecteurs les verront. La fonctionnalité permet de prévisualiser une seule page dans l'EDI ou d'ouvrir l'intégralité du site Web d'aide dans un navigateur.

Site : jetbrains.com/writerside