JetBrains Writerside: scrivere documenti come se fosse codice

JetBrains presenta Writerside, uno strumento software (per il momento gratuito) che aiuta gli utenti nella stesura di documenti tecnici. Trae vantaggio dalle principali funzionalità di un IDE avanzato come IntelliJ e si occupa di gestire i vari contributi del team, le revisioni e le modifiche.

Quando si parla di sviluppo software, JetBrains è uno dei nomi più noti. L’azienda è infatti specializzata nella creazione di strumenti e ambienti di sviluppo integrati (IDE) per programmatori. IntelliJ IDEA è uno dei prodotti più famosi: si tratta di un popolare ambiente di sviluppo integrato per Java, che supporta anche linguaggi come Kotlin, Groovy, Scala e così via.

L’attenzione alla produttività e all’usabilità ha fatto sì che gli IDE JetBrains diventassero ampiamente apprezzata dalla comunità degli sviluppatori. D’altra parte questi strumenti di sviluppo si distinguono per la presenza di funzionalità avanzate, di routine che assistono nella generazione del codice, per l’analisi e la correzione degli errori, gli strumenti di refactoring (applicazione di migliorie sul codice senza alterarne le funzionalità) e molto altro ancora.

JetBrains Writerside: cos’è e e come funziona

A beneficio di tutti coloro che sono soliti lavorare sulla documentazione, sulla creazione di tutorial, how-to, guide e via dicendo, JetBrains presenta Writerside. Si tratta di un ambiente per la scrittura tecnica a sua volta basato sulla piattaforma IntelliJ. In altre parole, il flusso di lavoro proprio dello sviluppo software è automaticamente trasportato e reso disponibile per le attività di scrittura di testi.

Writerside è in grado di eseguire oltre 100 test verificando l’eventuale presenza di link non funzionanti, risorse mancanti, valori di attributo non corretti e così via. I test possono essere personalizzati in modo che la documentazione utilizzi le convenzioni stilistiche e le impostazioni generali stabilite in azienda.

L’applicazione, disponibile nelle versioni stand alone per Windows, macOS e Linux (oltre che come plugin per gli IDE JetBrains), offre una serie di design predefiniti, facilmente personalizzabili. In questo modo gli autori non devono più occuparsi di layout e fogli di stile (CSS).

Uno degli obiettivi chiave di Writerside è consentire una collaborazione efficace tra sviluppatori e scrittori, colmando allo stesso tempo il divario tra di loro. L’applicazione impone un flusso di lavoro “doc as code” basato su strumenti di sviluppo come Git, pull review e controlli automatizzati per consentire a tutto il team di contribuire, revisionare e monitorare le modifiche come fanno gli sviluppatori con il codice di programmazione.

In questa prima fase, l’utilizzo di Writerside è sempre completamente gratuito. Probabile che lo strumento possa diventare a pagamento in futuro. JetBrains ha comunque anticipato che renderà disponibile una release gratuita.

Ti consigliamo anche

Link copiato negli appunti