Sette ragioni per usare Confluence per la documentazione tecnica

Quando gli scrittori tecnici si incontrano alle conferenze, una delle prime domande è di solito: “Quale strumento di authoring di aiuto usi per produrre contenuti di aiuto?”. E questa domanda è rapidamente seguita da “E quale strumento vorresti usare invece?”

A questo punto, la maggior parte delle persone della comunità techcomm si aspetta una risposta come “FrameMaker”, “Flare” o un CMS. Ma quando chiedono a Nils Bier, technical writer di K15t, lui li sconcerta con la sua risposta. “Usiamo Confluence, il wiki aziendale e lo spazio di lavoro del team, combinato con il nostro ultimo Scroll Apps. E per quanto riguarda la seconda domanda – Confluence è anche il mio strumento preferito per gestire i contenuti di aiuto e la documentazione dei prodotti”. Ecco perché.

#1 – Confluence può essere usato a livello aziendale

A K15t, usiamo Confluence in tutti i nostri dipartimenti. Tutti gli impiegati condividono le informazioni rilevanti negli spazi interni di Confluence. Gli sviluppatori organizzano le loro specifiche e registrano le loro decisioni di progettazione in Confluence. Il passo logico successivo, quindi, è quello di utilizzare Confluence per gestire il supporto e la documentazione del prodotto. Puoi vedere il nostro centro di aiuto basato su Confluence qui.

Perché pensiamo che sia così importante avere un account utente Confluence, tutti i nuovi dipendenti K15t ne ricevono uno nello stesso momento in cui ricevono i loro indirizzi email personali. Questo significa che ogni dipendente di K15t ha un account utente Confluence dal primo giorno – così possono accedere al wiki e aiutare a contribuire, sviluppare e migliorare la documentazione. E funziona: collaboriamo tutti con lo stesso strumento! Questa piattaforma wiki rende facile per tutti condividere, commentare e migliorare i contenuti. Lo stesso vale per la nostra documentazione di prodotto in Confluence.

E Nils sa che non si ferma qui. “Usiamo Confluence anche per gestire i contenuti del nostro sito web e blog”. È vero! Il post del blog che stai leggendo in questo momento è fornito da Confluence da Scroll Viewport.

#2 – Confluence funziona come ti aspetti

Chiunque abbia visto Confluence una volta sa come usarlo quasi istantaneamente. E a differenza di altri motori wiki, Confluence ispira veramente gli utenti a lavorare con esso. Confluence ha un’interfaccia utente pulita e un editor che funziona in modo molto simile al comune software di desktop publishing (DTP) o agli strumenti di elaborazione testi, come Microsoft Word.

I nuovi utenti hanno bisogno di pochissima formazione prima di essere pronti a lavorare con Confluence – in contrasto con le complesse piattaforme di authoring della guida. Semplicemente iniziano – e ben presto, tutti i nuovi utenti di Confluence scrivono, commentano e condividono come un professionista.

Confluence fornisce modelli di pagina (ad esempio per le note della riunione o modelli di pagina personalizzati per la documentazione di supporto) per aiutare gli utenti a sviluppare contenuti in modo rapido e coerente. Questo è un ottimo modo per assicurare strutture di pagina e contenuti coerenti. Ma quando gli autori decidono di andare oltre i loro modelli, possono fare anche questo.

Nils ama questo. “Confluence mi permette di strutturare il mio contenuto – ma allo stesso tempo, dà agli utenti la libertà di essere creativi.”

#3 – Confluence ti permette di coinvolgere colleghi e lettori

Condividere le pagine di Confluence con i colleghi è semplice. Puoi condividere l’ultima versione di una pagina della documentazione in pochi click. In K15t, i membri dello staff spesso lasciano commenti sulle pagine come un modo per condividere le loro intuizioni. Tutti quelli che guardano la pagina ricevono una notifica quando un commento è stato aggiunto.

Ma la caratteristica sociale preferita di Nils di Confluence è il pulsante “Mi piace”, che è simile a un “like” di Facebook. L’utente fa clic su “Mi piace” per confermare che tutto sulla pagina è corretto, e non sono necessari ulteriori miglioramenti.

I wiki come Confluence rendono molto più facile per tutti collaborare rispetto alle tipiche piattaforme di authoring di aiuto, che sono adatte solo per gli scrittori tecnici. Nella maggior parte dei casi in cui le aziende non prendono la strada del wiki, il contenuto deve essere esportato dal CMS per essere rivisto dai colleghi di altri dipartimenti. E una volta che hanno finito, le loro annotazioni e richieste di modifica devono essere reimportate ed elaborate manualmente.

#4 – Confluence è Web-Based

Non hai bisogno di installare nulla sul tuo computer per lavorare in Confluence. Tutto ciò di cui hai bisogno è il tuo browser web preferito (come Chrome o Firefox) e il tuo account utente personale. Tutti i contenuti sono gestiti centralmente sul tuo server Confluence aziendale, oppure puoi scegliere la strada del cloud con Confluence Cloud. Questo significa che tutti nella vostra azienda hanno accesso alle informazioni più recenti e possono aggiornare, condividere e contribuire ai contenuti – sempre e ovunque: in sede, in una filiale o anche in un viaggio di lavoro.

Nils è un fan dell’approccio basato sul web di Confluence: “Non ho più bisogno di preoccuparmi di aggiornare la mia toolchain locale di authoring della guida, perché Confluence è l’unico strumento di gestione dei contenuti che i nostri amministratori devono tenere aggiornato.”

#5 – Confluence offre piena trasparenza quando si crea il contenuto

L’idea alla base della collaborazione basata su wiki è consentire a chiunque di contribuire e fornire libero accesso alla conoscenza all’interno. Gli utenti possono guardare e confrontare le pagine per armarsi delle ultime conoscenze aziendali e osservare come il contenuto si evolve. La documentazione cresce letteralmente davanti ai propri occhi.

Ma a volte non ha senso condividere le informazioni con tutti i dipendenti. Con questo in mente, Confluence ti permette di limitare l’accesso e include una gestione dei diritti e dei ruoli a grana fine. Puoi facilmente definire chi è autorizzato a leggere, modificare o lasciare commenti su ogni pagina o spazio, per esempio.

#6 – Puoi personalizzare Confluence per adattarlo al tuo caso d’uso con alcune grandi (Scroll) Apps

Confluence non è un sistema di gestione dei contenuti (CMS) come tale. Ma è una piattaforma estensibile – e c’è una vasta gamma di applicazioni che si adattano al tuo caso d’uso, ad esempio la gestione dei contenuti per la documentazione tecnica. Per esempio, Scroll Versions porta il versioning simultaneo e la gestione delle varianti a Confluence Server e Data Center, e colma il divario tra un CMS completo e un wiki facile da usare. Se sei un utente Confluence Cloud, Scroll Documents ti permette di controllare le versioni, tracciare le modifiche e gestire il flusso di lavoro di sviluppo dei contenuti come un team di documentazione.

Nils aggiunge: “Non posso più immaginare di lavorare senza queste Scroll Apps per Confluence. Mi fanno risparmiare così tanto tempo – tempo che ora posso passare a scrivere, invece di copiare e gestire manualmente il mio contenuto di aiuto.”

#7 – Confluence è ideale per ambienti agili

Come molte aziende di software, K15t segue il paradigma di sviluppo agile. La documentazione di supporto, come i prodotti, si evolve iterativamente all’interno di sprint e rilasci. Poiché i cicli di rilascio diventano sempre più brevi, i redattori tecnici devono tenere il passo. Questo è possibile solo se tutti nel team lavorano con lo stesso strumento, dove possono contribuire alle informazioni e dare un feedback immediato sul contenuto della guida.

Nils descrive il suo flusso di lavoro per il rilascio della documentazione. “Lavoro alla prossima versione della nostra documentazione, e quando i nostri sviluppatori fanno uscire la release del prodotto dalla porta, semplicemente pubblico e aggiorno il mio contenuto di aiuto usando Scroll Versions. Ci vogliono solo pochi click.”

Conclusione: Altri casi d’uso (e motivi) a venire

Confluence ha iniziato come una piattaforma di gestione della conoscenza e collaborazione. Gli utenti hanno trovato il modo di sfruttare quella piattaforma per altri casi d’uso, e hanno attratto nuovo pubblico. E allo stesso modo, il numero di ragioni per usare Confluence per la documentazione tecnica sta aumentando ogni giorno – con ogni nuova release di Confluence e con ogni nuova app che arriva sul Marketplace di Atlassian.

Quali sono le ragioni per cui usate o valutate Confluence per la documentazione tecnica? E dove vedi i vantaggi rispetto ai tradizionali strumenti di authoring della guida? Lascia un commento e facci sapere!

Se hai qualche domanda, non esitare a mandarci un’email a [email protected] .