con Lato dello scrittoreJetBrains mira a consentire a sviluppatori e scrittori di creare documentazione tecnica utilizzando un flusso di lavoro di scrittura, test e creazione. Il nuovo strumento è basato sull’IDE della piattaforma IntelliJ ed è stato utilizzato per creare la maggior parte della documentazione dei prodotti JetBrains negli ultimi anni.

Questo progetto è stato sviluppato attraverso centinaia di interviste ai clienti e oltre 10 anni di lavoro sulla documentazione della piattaforma IntelliJ. Questi esperimenti ci hanno fornito un lungo elenco di funzionalità da realizzare e problemi da risolvere.

Uno degli obiettivi principali di WriterSide è consentire una collaborazione efficace tra sviluppatori e scrittori e colmare il divario tra loro. Applica un percorso “doc as code” basato su strumenti di sviluppo come Git, pull review e controlli automatizzati per consentire all’intero team di contribuire, rivedere e tenere traccia delle modifiche man mano che vengono utilizzate con il codice. Questo, secondo JetBrains, semplifica il processo di documentazione.

WriterSide supporta sia Markdown che tag personalizzati basati su XML e consente agli autori di combinare entrambi i formati nello stesso documento. Ciò rende possibile introdurre funzionalità semantiche in un documento Markdown per arricchirlo, ad esempio. Al contrario, WriterSide supporta anche la traduzione rapida di parti Markdown in XML e l’importazione in un documento XML.

WriterSide può eseguire più di 100 test integrati, come test per collegamenti interrotti, risorse mancanti, valori di attributi errati, ecc. I test possono essere personalizzati per l’ortografia interna e le convenzioni di stile. Lo strumento fornisce anche design predefiniti che possono essere facilmente personalizzati in modo che gli autori non debbano occuparsi di layout e CSS.

Poiché agli autori viene richiesto di scrivere XML o Markdown, WriterSide include una funzionalità di anteprima dal vivo che riflette istantaneamente ogni modifica ed evidenzia eventuali errori. Ciò è particolarmente utile quando non è possibile accedere a una pipeline CI/CD o per build più lunghe, quindi è possibile controllare l’output senza attendere che finisca.

Come nota finale sulle funzionalità di WriterSide, offre un controllo ortografico e una correzione grammaticale basati sull’intelligenza artificiale creati da JetBrains e supporta oltre 25 lingue.

WriterSide è disponibile come file Plugin per IDE JetBrains Come applicazione autonoma all’interno Programma di accesso anticipato (Eep). Il prodotto è completamente gratuito per tutta la durata dell’EAP, ma JetBrains ha promesso che avrà una versione gratuita o un EAP continuo per consentire l’uso gratuito dello strumento.