Trop peu de développeurs créent de la documentation correcte et utilisable à mon goût. Il suffit de voir la documentation du langage Java. (Les membres du Discord Eridiane savent très bien ce que j'en pense...)
Une bonne documentation est pourtant très importante, que cela soit pour les développeurs qui travailleront avec vous ou après vous sur votre code pour le maintenir, ou pour d'autres utilisateurs via des didacticiels ou des manuels.
Avec une bonne documentation, un développeur est capable de coder plus rapidement et à mon sens, avec d'avantage de plaisir.

Jetbrains est toujours aussi créatif, et vient de sortir l'application Writerside.

Qu'est ce que Writerside ?

Writerside  est un environnement de création de documentation. Il sert à créer et à publier de la documentation technique pour votre logiciel ou pour votre API. Il met à disposition des rédacteurs des outils comme Git, les « pipelines de build » et les vérifications automatiques (vérification des liens brisés par exemple, correcteur orthographique, etc).

Il utilise deux types de langages que vous pouvez combiner : Markdown et XML. Les personnes écrivant la documentation pourront voir la documentation comme elle s'affichera pour leurs utilisateurs.

Writerside existe en tant que logiciel, et aussi en plugin pour les IDE JetBrains. L'application peut être personnalisée et elle prend en charge 25 langues différentes. Pour le travail à plusieurs, le travail se fait via Git.

Pour le moment, l'application prend en charge de la documentation destinée au web. Elle supporte l'ajout de diagrammes utilisant PlantUML.

L'application ressemble beaucoup au plugin Jupyter Notebook qu'il ya (ou avait) dans Pycharm, mais en plus complet bien sûr.

Le prix ?

WriterSide est pour le moment en accès anticipé et il est gratuit.
Par la suite, il y aura une version payante et une autre gratuite comme pour ses logiciels PyCharm ou Intellij IDEA par exemple.

Un petit tutoriel réalisé par la « Product Manager ».