Optimisez l'écriture, les tests, les builds et la publication des tutorielsguides explicatifsréférences APIguides utilisateursdocs SDK

Le plus puissant des environnements de développement, désormais adapté à la rédaction de documentation

Documents en tant que code prêts à l'emploi

Pipeline de documents en tant que code

Utilisez un environnement de création unique pour éviter de recourir à un large éventail d'outils. Grâce à l'interface utilisateur Git intégrée, à un outil de build intégré, aux tests automatisés et à la mise en page prête à l'emploi et personnalisable, vous pouvez vous concentrer sur ce qui compte le plus : votre contenu.

Combinaison de Markdown et XML

Vous pouvez désormais allier les avantages de Markdown à ceux du balisage sémantique. Restez sur un seul format ou enrichissez le balisage à l'aide d'attributs et d'éléments sémantiques, de diagrammes Mermaid et de formules mathématiques LaTeX.

Automatisation de la qualité des documents

Garantissez 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 Live Preview et pendant le build.

Aperçu en direct

L'aperçu affiche les documents exactement comme vos lecteurs les verront. Prévisualisez une seule page dans l'IDE ou ouvrez l'intégralité du site d'aide dans votre navigateur sans avoir à exécuter le build.

Source unique

Réutilisez tout, des petits morceaux de contenu aux sujets ou sections entières de votre table des matières. Restez flexible grâce aux filtres et aux variables. Utilisez des modèles prédéfinis pour les éléments de balisage complexes, ou créez les vôtres.

Documentation API et produit, rassemblement !

Plus besoin de basculer entre les outils pour créer de la documentation utilisateur et des références API. Incorporez des documents API dans votre site web d’assistance, publiez-les avec la même mise en page et complétez les références générées automatiquement par du contenu écrit manuellement.

Découvrez son fonctionnement

Créé par des auteurs techniques…
pour les auteurs techniques

Ce projet a vu le jour suite à des centaines d'entretiens avec nos clients et plus de 10 ans de travail sur la documentation de la plateforme IntelliJ. Ces expériences nous ont fourni une longue liste de fonctionnalités à développer et de problèmes à résoudre. Nous sommes là pour les traiter un à un.

Vous voulez nous aider ? Testez Writerside et dites-nous ce que vous en pensez !

Utilisez Writerside pour créer des documents de ce type

Notre plateforme de documentation est déjà utilisée pour nombreux produits JetBrains. Tirez parti de nos connaissances, de notre expérience et de nos modèles pour générer la documentation de vos produits.

Questions fréquentes

Writerside est désormais distribué en tant que programme d'accès anticipé et il est entièrement gratuit.

Par la suite, nous proposerons une version gratuite de Writerside ou un programme EAP en continu, afin que l'outil puisse encore être utilisé gratuitement.

Writerside propose deux types de fichiers sources : Markdown et XML, mais vous n'êtes pas pour autant limité à un seul format. Vous pouvez écrire en Markdown et injecter des éléments plus compliqués, comme des attributs sémantiques et des éléments XML. Les deux balises bénéficient d'une assistance complète dans l'éditeur, incluant la saisie semi-automatique et la validation.

Si votre base source principale est en XML, vous pouvez accepter les demandes de modification de contributeurs externes dans Markdown, puis convertir Markdown en XML. De même, vous pouvez convertir des fragments Markdown en XML, par exemple si vous devez fusionner des cellules dans un tableau.

Nous espérons qu'une combinaison de Markdown et de balisage sémantique basé sur XML couvrira la plupart des cas d'utilisation. Nous restons toutefois ouverts à vos retours d'expérience, alors n'hésitez pas à nous dire s'il vous manque des fonctionnalités fournies par un autre balisage.

Vous pouvez stocker des fichiers localement, mais il est recommandé d'utiliser un dépôt Git. Nous fournissons une interface utilisateur pratique pour toutes les opérations Git, la gestion des branches et la résolution des conflits. Vous pouvez également utiliser un autre système de contrôle de version pris en charge, tel que Subversion ou Perforce.

Bien que nous soyon adeptes de la documentation web, les utilisateurs peuvent avoir besoin de produire des formats imprimés. Depuis janvier 2024, nous prenons en charge la sortie PDF.

Writerside vous permet de créer votre projet de documentation localement et de produire un fichier .zip. Vous devrez ensuite le mettre en ligne sur votre site web ou l'héberger sur GitHub Pages, Amazon AWS, Netlify ou tout autre service d'hébergement. Nous envisageons de proposer notre propre service d'hébergement de documents à l'avenir.

Si vous utilisez un serveur de CI/CD, nous pouvons fournir des scripts de création sous forme de conteneur Docker, à utiliser pour configurer les builds de documentation.

Vous pouvez configurer Writerside pour produire des index de recherche Algolia et vous enregistrer sur Algolia pour bénéficier d'un forfait gratuit.

Nous travaillons également sur notre propre solution de recherche.

La version initiale de Writerside offre quelques options de personnalisation. Voici quelques exemples de ce que vous pouvez faire :

  • Modifiez l'apparence de l'en-tête et du pied de page.
  • Ajoutez votre logo et vos informations de copyright.
  • Choisissez entre trois préréglages de couleurs (doux, contrasté et vif) tous compatibles avec les thèmes clairs et sombres.
  • Choisissez une couleur d'accent pour les éléments mis en évidence.
  • Intégrez des liens vers les réseaux sociaux et d'autres ressources.

Nous prévoyons d'ajouter davantage d'options et d'améliorer encore la personnalisation des documents.

Si vous disposez de sources Markdown, vous pouvez les importer dans un projet Writerside. Nous travaillons également sur la migration des formats basés sur XML, notamment DITA.

Nous publions des mises à jour régulières dans notre espace de travail Slack (veuillez lire notre Code de conduite avant de nous y rejoindre). Vous pouvez également suivre notre projet dans YouTrack pour signaler tout problème rencontré ou formuler vos demandes de fonctionnalités.

Vous pouvez également vous abonner à notre newsletter, où nous annonçons toutes les mises à jour importantes des produits.