4 tecnologie open source per facilitare la scrittura
Se stai iniziando a scrivere tecnicamente, potrebbe interessarti questo elenco di tecnologie aperte che semplificano la scrittura tecnica.
Parallelamente insegno corsi universitari e uno dei corsi dello scorso semestre è stato Scrivere con la tecnologia digitale, in cui gli studenti hanno appreso le diverse tecnologie e strumenti utilizzati dagli scrittori tecnici nel settore. Gli argomenti includevano HTML, CSS, XML, DITA, Markdown, GitHub e altri strumenti e tecnologie di scrittura.
Concludendo lo scorso semestre, io e la mia classe abbiamo ripensato alle tecnologie che ci piaceva apprendere. Se stai iniziando a scrivere tecnicamente, potrebbe interessarti questo elenco di tecnologie aperte che semplificano la scrittura tecnica.
HTML
Ogni sito web è costruito su HTML, l'HyperText Markup Language. Sebbene gli scrittori tecnici professionisti possano utilizzare strumenti basati sul Web come Drupal o TYPO3 per creare pagine Web, è sempre bello sapere come funzionano le cose dietro le quinte imparando l'HTML. Sebbene ciò non accada molto frequentemente, a volte uno strumento basato sul Web genera codice HTML errato. Gli autori tecnici devono sapere come correggere le pagine Web modificando l'HTML senza interromperlo ulteriormente.
Il codice HTML è interamente basato su testo, con tag racchiusi tra parentesi angolari. Gli elementi sono in blocco o in linea, ad esempio
per definire un paragrafo in blocco o per mettere enfasi (solitamente in corsivo) su una parola o frase.
Gli autori tecnici potrebbero concentrarsi sulla scrittura di contenuti in HTML e sulla definizione di stili in un file CSS o foglio di stile separato per definire il modo in cui il contenuto appare sullo schermo. Questa separazione tra contenuto e aspetto è un ottimo modo per concentrarsi sulla scrittura.
Ribasso
Un altro modo in cui puoi scrivere la documentazione è con Markdown. Markdown mira a semplificare la scrittura tecnica rimuovendo quanta più sintassi di markup possibile, sostituendola con convenzioni standard che potresti utilizzare quando scrivi in un file di testo semplice.
Ad esempio, per iniziare un nuovo paragrafo in Markdown, aggiungi una riga vuota nel file di testo. Il paragrafo successivo inizia con il blocco di testo successivo. Aggiungi intestazioni disegnando una linea sotto di essa, come questa per creare un'intestazione di livello superiore:
Title of my document
====================
E questo per creare un sottotitolo in un documento:
How to use the software
-----------------------
Markdown viene spesso utilizzato quando si scrivono file Leggimi o altra documentazione di progetto su GitHub o GitLab. Ciò rende Markdown una scelta popolare per gli sviluppatori open source e per gli scrittori tecnici.
DITA
Darwin Information Typing Architecture (DITA) è essenzialmente un file XML con una particolare struttura di file. Quando creano la documentazione di progetto con DITA, gli autori tecnici si concentrano su come riutilizzare e remixare i contenuti per creare nuovi tipi di file di output.
Ad esempio, tre formati di file DITA comuni sono DITA Concept che descrive una cosa o un processo, DITA Task che elenca i passaggi per eseguire un processo e DITA Reference che fornisce solo i fatti su un argomento, come avvertenze o note importanti.
DITA è uno strumento potente per gli scrittori tecnici perché puoi assemblare un documento creando un file XML separato chiamato DITAMap che compila diversi file DITA su un argomento. Ciò consente agli autori tecnici di riutilizzare i contenuti senza copiare e incollare tra documenti separati. DITA Open Toolkit e altri strumenti DITA forniscono trasformazioni che trasformano l'origine DITA in diversi tipi di output, inclusi documenti PDF, siti Web HTML e libri EPUB.
LibreOffice
Se preferisci utilizzare un tradizionale elaboratore di testi per scrivere la documentazione, LibreOffice Writer fornisce un'eccezionale opzione open source. Gli scrittori possono sfruttare diversi stili disponibili in LibreOffice per definire titoli di capitoli, intestazioni di sezione, paragrafi e codice di esempio all'interno di un documento. LibreOffice supporta anche gli stili di carattere che aiutano a dare enfasi o evidenziare le parole chiave del codice sorgente e altro testo in linea.
Gli stili di pagina in LibreOffice consentono una grande flessibilità nella creazione di documentazione stampata. Ad esempio, gli stili di pagina includono le pagine sinistra e destra, generalmente utilizzate nei documenti più lunghi per garantire che i nuovi capitoli o le sezioni principali inizino sempre sulla pagina destra di un libro stampato. Intestazioni e piè di pagina possono essere definiti indipendentemente sulle pagine sinistra e destra, offrendo una maggiore flessibilità nella scrittura tecnica.
LibreOffice è un elaboratore di testi desktop più tradizionale con un'interfaccia facile da imparare. La maggior parte delle funzionalità è disponibile direttamente sulla barra degli strumenti, con funzionalità aggiuntive nei menu. Oppure utilizza il riquadro Stili a comparsa per selezionare rapidamente lo stile di paragrafo, carattere o pagina che desideri utilizzare.
Questo articolo è stato scritto in collaborazione con: Teagan Nguyen, Joshua Hebeisen, Aurora Dolce, David Kjeldahl e Rose Lam.