Free Press

Prendendo da dove abbiamo lasciato nella parte 1 della serie di strumenti di scrittura tecnica. (Controllate se non l’avete letto)
In questa puntata, ci occupiamo degli strumenti di scrittura tecnica usati nella fase “Documentare le informazioni”.
Questa è la fase di scrittura, editing, disegno, revisione e riscrittura. Questa è la fase in cui il team di documentazione delle informazioni è al massimo della sua forza e sforna guide, manuali, blog, video dimostrativi, pagine di aiuto online e quant’altro. Data la varietà dei compiti in questa fase, anche gli strumenti di scrittura tecnica impiegati sono abbastanza diversi e innumerevoli.

Top 17 strumenti software di scrittura tecnica per la documentazione nel 2020

• • Whatfix
  • MediaWiki
  • Adobe Robohelp

• Notepad++
• WordPress
• Adobe Photoshop
• Adobe Illustrator
• Microsoft Visio
• Windows Snipping Tool
• Windows Movie Maker
• Powtoon
• Prezi
• Microsoft Word
• Kingsoft WPS Office
• Google Docs
• Adobe Framemaker
• oXygen XML Author

1. Whatfix

Whatfix significa un cambio di paradigma nel modo in cui la documentazione di aiuto è presentata online. Pagine di aiuto statiche e lunghe non catturano l’attenzione dell’utente in modo efficace come le guide interattive e illustrate presentate da Whatfix, popolarmente chiamate ‘balloon’.
Inoltre, l’aiuto online nel mondo di oggi ha bisogno di diffondersi su vari gadget – che siano PC, tablet o smartphone. Whatfix adatta automaticamente il contenuto della guida per adattarlo al gadget. E lo stesso contenuto di aiuto può essere accessibile in forme diverse – come una presentazione, un PDF o un video.
Suggerimento dell’autore: Whatfix supporta una caratteristica unica – Real-time Interactive walkthrough – in cui metti i tuoi snippet di aiuto direttamente nella pagina del prodotto dal vivo! L’utente legge lo snippet nel balloon di Whatfix ed esegue l’azione di conseguenza sulla pagina. Questo è uno strumento di scrittura tecnica popolare tra le aziende che cercano un cambiamento dalle metodologie tradizionali.

MediaWiki

Visualizzare l’aiuto online del tuo prodotto come pagine wiki è un’idea semplice ed efficace. Le tue pagine possono essere integrate direttamente in Wikipedia se non hai un sito web separato per il tuo prodotto online. In alternativa, puoi ospitare le pagine di aiuto come Wiki sul sito web del tuo prodotto. L’alta familiarità di questo formato tra gli utenti online è un vantaggio chiave, e lo strumento di editing wiki gratuito MediaWiki Visual Editor rende la creazione di aiuto abbastanza semplice.
MediaWiki è uno strumento di editing web basato su PHP, che Wikipedia utilizza. Tuttavia, anche le grandi società di software, Intel è un esempio chiave, usano questo strumento per presentare le loro vendite e informazioni di marketing, How To’s, e pagine di aiuto su politiche e procedure.
Suggerimento dell’autore: Questo strumento di scrittura tecnica è dotato di un buon supporto per le estensioni – per contenuti multilingue, revisione collaborativa, monitoraggio delle modifiche, ricerca integrata, ecc.

Adobe RoboHelp

Strumento di authoring standard del settore usato per creare sistemi di aiuto per applicazioni desktop o web-based. Nessun utente di computer è estraneo a RoboHelp! Ogni volta che premi F1 in una qualsiasi delle tue applicazioni software standard, la finestra di aiuto che appare è quasi sempre creata usando RoboHelp. Tuttavia, può anche essere usato per sfornare la documentazione tecnica convenzionale per la stampa, come guide e manuali.
Il sofisticato IDE RoboHelp permette agli scrittori tecnici di sviluppare progetti di aiuto su larga scala e renderli su più dispositivi hardware/sistemi operativi, e in più formati (PDF, HTML, DOC, ecc.). La versione più vecchia di RoboHelp può essere acquistata come edizione a basso costo se il budget è un vincolo. Tuttavia, le piccole aziende possono attenersi a semplici alternative gratuite come blog WordPress o Wiki. Anche il buon vecchio MS Word può generare file di aiuto HTML di base per voi.
Suggerimento dell’autore: Gestire prodotti software di grandi dimensioni con versioni di aggiornamento regolari può essere una grande sfida per i redattori tecnici in quanto devono essere sincronizzati con la storia dei cambiamenti del prodotto. I file di aiuto spesso mostrano variabili configurabili definite dall’utente che sono ripetute più volte nella documentazione di aiuto. (Per esempio, una variabile come “Tempo di sospensione dopo l’inattività” è impostata a 30 sec nella versione precedente, per essere impostata a 1 min nell’aggiornamento). Il progetto RoboHelp si occuperebbe di aggiornare il valore della variabile in tutti i file di aiuto!

Notepad++

Un editor HTML per principianti molto efficace. La maggior parte delle persone impara le basi della programmazione HTML su questo strumento di scrittura tecnica. Se il vostro prodotto software non richiede una documentazione online molto pesante, per fare file di aiuto di medie dimensioni, questo strumento è più che sufficiente.
La sua GUI personalizzabile permette una facile modifica, supporta WYSIWYG per la stampa e ha anche opzioni di supporto multilingue.
Suggerimento dell’autore: Notepad++ viene fornito con un ricco set di plug-in. Multi-clipboard, Code Compare, Auto-Save sono alcuni popolari. Gli scrittori tecnici hanno bisogno di scegliere il giusto set di plug-in, che possono trasformare un normale editor per principianti in una valida opzione per l’editing della guida in linea.

WordPress

Il posto GoTo se vuoi avere la documentazione tecnica per il tuo prodotto sotto forma di blog. WordPress è una piattaforma di gestione dei contenuti online open source e gratuita. I blog scritti su WordPress possono essere accessibili direttamente dall’URL del blog WordPress o possono essere integrati nel vostro sito web aziendale.
Questo articolo stesso è ospitato sul blog WordPress chiamato Whatfix Academy. Se l’obiettivo è quello di pubblicare contenuti online sulla vostra azienda / tecnologie associate regolarmente, allora impostate un account blog WordPress. I blog possono anche catturare le risposte degli utenti sotto forma di commenti e “mi piace”, il che rende più facile impegnarsi con il vostro pubblico di destinazione e percepire il loro apprezzamento per il vostro prodotto.
Suggerimento dell’autore: I blog da soli potrebbero non raccogliere abbastanza occhi. Quindi, scrivi il tuo blog prima, promuovi il tuo blog sulle piattaforme dei social media dopo e infine misura il numero di spettatori/risposte prima di andare avanti con la prossima serie di blog!
Leggi anche: Come la scrittura tecnica sta cambiando con i tempi

Adobe Photoshop

Uno strumento che la maggior parte degli scrittori tecnici in tutto il settore usano. È lo strumento di editing di immagini più popolare al mondo per creare e modificare foto e opere d’arte basate su raster (pixel). Può essere usato per creare design di interfacce utente, pagine web, banner pubblicitari, grafica video, editing di immagini per la stampa. Manipolare un’immagine, sovrapporre un’immagine ad un’altra, raffinare una fotografia per eliminare le imperfezioni, correggere i problemi di illuminazione sono i suoi usi più popolari. Il processo di editing delle immagini è reversibile e incrementale in modo che le modifiche possano essere riportate indietro facilmente.
Suggerimento dell’autore: Per i designer professionisti, che hanno costantemente bisogno di uno strumento di editing delle immagini, non c’è quasi nessun sostituto di Adobe Photoshop. Tuttavia, se sei un utente occasionale, prova GIMP che è open source. Supporta solo schemi di colore RGB mentre Photoshop supporta anche la modalità di colore CMYK (CYAN YELLOW MAGENTA BLACK). E la curva di apprendimento è più alta per GIMP, ma è gratuito mentre Photoshop costa una bomba!

Adobe Illustrator

Strumento per creare e modificare illustrazioni vettoriali come loghi e marchi o altri elementi di design. I designer grafici fanno spesso l’errore di disegnare i loghi dei loro prodotti su Photoshop. Ma lo stesso logo deve essere stampato su biglietti da visita, così come su enormi cartelloni pubblicitari. Quindi, il ridimensionamento dell’immagine senza perdere la chiarezza è la chiave qui, che gli strumenti di imaging basati sulla grafica vettoriale raggiungono. Adobe Illustrator e Corel Draw sono i principali strumenti di scrittura tecnica in questo spazio: Questo strumento fa parte della soluzione Adobe Creative Cloud con costosi noleggi mensili. Strumenti alternativi gratuiti di scrittura tecnica come Inkscape o Affinity Designer possono fare il lavoro altrettanto bene con i formati SVG. A meno che non abbiate bisogno di tutti i principali strumenti di scrittura tecnica che fanno parte di questa soluzione (Photoshop, InDesign, ecc.), questo strumento non è un must-have.

Microsoft Visio

Un popolare strumento di diagrammi usato nella progettazione di applicazioni di ingegneria. I redattori tecnici hanno spesso bisogno di progettare diagrammi di flusso, diagrammi architettonici, schemi di circuiti elettrici, progettazione di prodotti software e così via. Visio è un aiuto conveniente per questo.
È uno strumento di scrittura tecnica conforme a IEEE che è conforme agli standard dell’industria del software come UML (Unified Modeling Language) e BPMN (Business Process Model and Notation).
Suggerimento degli autori: Visio non ha fatto parte della tradizionale suite di Microsoft Office, è sempre stato venduto separatamente come MS Project. Ma un annuncio molto recente di Microsoft dice che gli abbonati online di Office 365 possono ora accedere anche a Visio.

Windows Snipping Tool

Se state cercando opzioni di cattura dello schermo che siano più sofisticate di PrntScr sulla vostra tastiera, Snipping Tool è una buona scelta. Oltre alla cattura a schermo intero, potete anche catturare ritagli a mano libera, o ritagli parziali di aree dello schermo. Per catturare immagini fisse dai video, usa l’opzione di ritardo in modo che il fotogramma esatto possa essere salvato come immagine.
Suggerimento per gli autori: fa parte della suite di software di Windows, ma potrebbe non essere abilitato di default in alcune edizioni di Windows.

Windows Movie Maker

Un semplice strumento di editor video che gli scrittori tecnici possono usare per fare i loro video dimostrativi dei prodotti. Fa parte della suite Windows Essentials. Tuttavia, da gennaio 2017, questo software è stato interrotto, senza l’annuncio di una sostituzione adeguata. Quindi, tutti quegli utenti con vecchie versioni di Windows, ringraziate la vostra buona stella!
Suggerimento per gli autori: I video e i ritagli audio possono essere organizzati e modificati in una vista storyboard, fotogramma per fotogramma. Oppure una serie di immagini fisse può essere allungata su una linea temporale. Le voci fuoricampo, unite ai suoni di sottofondo, possono dare ai tuoi video un tocco sofisticato.

Powtoon

La scrittura tecnica sta diventando sempre più visiva. I video animati sono un modo eccellente per catturare l’attenzione dell’utente e trasmettere il messaggio in modo coinvolgente. Powtoon è un buon strumento di animazione basato sul web, venduto come prodotto SaaS. Presentazioni animate e video esplicativi possono essere creati utilizzando questo strumento gratuitamente. Tuttavia, i video creati con la versione gratuita porterebbero una filigrana ‘Powtoon’.
Suggerimento per gli autori: Se la scrittura tecnica non è per scopi ufficiali, è perfettamente OK usare la versione gratuita di questo strumento. Tuttavia, con un noleggio nominale, si potrebbe ottenere la versione premium che permette di creare video senza la filigrana e diverse altre caratteristiche.

Prezi

Un approccio non convenzionale per fare demo sotto forma di presentazione video. A differenza di Powerpoint, dove il contenuto è rigidamente diviso in diapositive, Prezi ti dà solo un’enorme tela bianca. Si può andare a scrivere, disegnare su di essa come si vuole. Ingrandendo o riducendo il contenuto a fuoco e spostando la messa a fuoco da un fotogramma all’altro sulla stessa tela – è così che si fa una presentazione video continua: Oltre alla versione gratuita, c’è una versione di prova per studenti, anch’essa gratuita, che ha quasi tutte le caratteristiche della versione a pagamento. Scegliete quella.
Leggete anche – 14 idee sbagliate di scrittura tecnica che dovreste conoscere!

Microsoft Word

Sembra piuttosto sciocco scrivere dell’onnipresente MS Word. Ma per quanto comune possa essere nella nostra vita digitale quotidiana, è ancora il migliore amico di uno scrittore tecnico! Con una facile conversione tra i formati PDF e DOC, la semplice combinazione di Word e Adobe Acrobat Reader non è da prendere alla leggera. Questo articolo potrebbe riguardare tutti i fantasiosi strumenti di scrittura tecnica del mondo, ma è stato scritto usando l’umile MS Word! Sperimentate con i vari modelli di documento che Word ha in offerta. Aiutano a rendere il tuo documento appropriato per lo scopo previsto – come volantini di marketing, whitepaper tecnici, guide alla risoluzione dei problemi, e così via.

Kingsoft WPS Office

MS Word, PowerPoint, ed Excel sono noti per essere gli strumenti software di scrittura tecnica più usati, miglia avanti alle alternative disponibili. Solo la rivoluzione Android ha rallentato un po’ il juggernaut di MS Office. E ha dato una posizione di rilievo a Kingsoft Office, un’alternativa ragionevole e gratuita a MS Office: Ci sono alcune caratteristiche sfumate che WPS Writer non supporta – Thesaurus è una di queste. Thesaurus è una caratteristica importante per gli scrittori tecnici, dato che siamo costantemente alla ricerca di parole migliori per esprimere gli stessi punti in diversi documenti tecnici!

Google Docs

In un mondo che si sta sempre più rivolgendo a un comodo telefono cellulare per leggere i documenti, piuttosto che prendersi il disturbo di accendere il computer, Google Docs sta lentamente guadagnando importanza. Creare documenti da zero non sarebbe conveniente su Google Docs, ma la revisione e la modifica collaborativa possono essere fatte in modo efficiente attraverso questa alternativa basata su cloud a MS Office.
Suggerimento dell’autore: La sua perfetta integrazione con Gmail e Google Drive lo rende ancora più attraente. Come scrittore tecnico, ti attieni ai sofisticati strumenti di elaborazione dei testi. Ma il tuo product manager, che potrebbe essere sempre in movimento, è sicuro di recuperare le sue recensioni sul suo telefono, con ogni probabilità!

Adobe Framemaker

Un sofisticato elaboratore di documenti per documenti grandi e standard industriali. Può essere usato per generare documenti strutturati con un framework XML, con il 100% di conformità DITA. Può essere usato anche per documenti non strutturati, in sostituzione di editor di documenti come MS Word.
Framemaker è una buona scelta per generare documenti strutturati con modelli predefiniti per conformarsi a diversi formati standard industriali – come accordi legali e dichiarazioni finanziarie. Supporta la creazione di TOC o indici su più documenti, ha ricche opzioni di formattazione. Non cala nelle prestazioni quando vengono inseriti dei grafici.
Suggerimento dell’autore: Framemaker è un buon investimento per aziende consolidate con team formali di scrittura tecnica che hanno bisogno di produrre grandi documenti di oltre 100 pagine. Tuttavia, le aziende a prodotto singolo e le startup non hanno bisogno di fare questo investimento. Ci sono strumenti di authoring di documenti basati su XML disponibili gratuitamente. E si può sempre ripiegare sul buon vecchio MS Word!

oXygen XML Author

Questo è un editor XML gratuito e open source conforme a DITA, con diversi utenti fedeli e buone recensioni. DITA (Document Information Typing Architecture) è uno standard aperto per la creazione e la pubblicazione di documenti che si è lentamente fatto strada nella gestione dei documenti tecnici. Semplicemente perché rimuove la dipendenza dell’editing del contenuto da uno strumento particolare. Si produce una documentazione online conforme a DITA (un insieme di file XML), poi la modifica e la manutenzione in futuro sarà possibile attraverso qualsiasi altro strumento conforme a DITA!
Poiché le specifiche DITA sono un’area che richiede un’attenzione speciale, lasciatemi risparmiare questo per un altro articolo: Basta dire che la suite di strumenti oXygen è una valida alternativa al popolarissimo ma proibitivo Adobe Framemaker. oXygen Author è generalmente usato in combinazione con oXygen Developer.
Quindi, questo è tutto il software di scrittura tecnica di cui avrete bisogno nella fase “Informazioni sul documento”. La prossima e ultima parte sarà dedicata alla fase di “Pubblicazione delle informazioni”.
Per imparare alcuni ottimi consigli di scrittura tecnica e per essere sicuri di non perdere i nostri aggiornamenti sugli strumenti di scrittura tecnica, iscriviti al nostro blog.
Ti piace? Segnalibro l’articolo o condividilo con i tuoi amici e colleghi!

Noi di Whatfix, stiamo innovando lo spazio degli strumenti di scrittura tecnica sconvolgendo l’idea stessa di contenuti scritti lunghi e continui. Le nostre guide interattive vi aiuteranno a diventare più produttivi fornendovi un modo rapido ed efficace per creare documentazione tecnica. Leggi di più su come Whatfix aiuta nella scrittura tecnica in questo articolo.