Un outil de création de documentation technique chez JetBrains

Basé sur une interface utilisateur Git, l'outil de conception intégrée Writerside de JetBrains facilite la création de documents techniques, de références d'API et de guides pour les développeurs. Il s'appuie notamment sur des fonctions de tests automatisés et de prévisualisation en direct.

JetBrains a présenté la bêta de Writerside, un outil de création et de publication pour aider les développeurs et les rédacteurs à produire de la documentation technique. Lancé en accès anticipé le 16 octobre dernier, Writerside permet aux développeurs et aux rédacteurs de collaborer à la documentation produit, aux références d’API, aux guides pour le développeur, aux tutoriels et aux modes d'emploi. Un correcteur orthographique et grammatical basé sur l'IA prend en charge plus de 25 langues, dont l'anglais, l'allemand, l'espagnol et le chinois.

Parmi les autres fonctionnalités de Writerside, on peut citer :

- Une interface utilisateur Git intégrée ;

- La prévisualisation en direct, avec des documents apparaissant exactement tels que les lecteurs les verront, sans attendre la compilation de production ;

- La prise en charge de Markdown, XML ou de l'utilisation combinée des deux. Les développeurs peuvent injecter des attributs sémantiques ou des éléments sémantiques pour enrichir Markdown, et les éléments Markdown peuvent être convertis en XML ;

- Des designs prêts à l'emploi, avec des options de personnalisation qui incluent le choix du mode sombre ou clair, du contraste, des skins doux ou éclatants, et la définition d'une couleur dominante pour s'adapter à une marque. Les auteurs peuvent se concentrer sur le contenu sans avoir à concevoir la mise en page et à gérer les feuilles de style CSS ;

- Des tests automatisés pour détecter les liens brisés, les ressources manquantes, les valeurs d'attribut incorrectes et les identifiants non uniques. La possibilité de mettre en évidence et de valider du code, avec des inspections intégrées ;

- Une source unique de vérité pour un projet est maintenue en vue de la réutilisation du contenu.

Les développeurs intéressés peuvent télécharger gratuitement Writerside pendant le programme d'accès anticipé pour Windows, macOS et Linux. Comme on est jamais mieux servi que par soi même, JetBrains a par ailleurs indiqué utiliser Writerside en interne pour rédiger de la documentation sur des produits allant du SDK IntelliJ Platform au langage de programmation Kotlin.