Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- LibreOffice
- Technical writer:
- quaffeina
- Nome progetto:
- Guida online di LibreOffice: una guida simile a quelle usate per altre applicazioni LO, che include non solo l'utilizzo, ma anche l'installazione e l'amministrazione.
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Se selezionato, ho in programma di dedicare dalle otto alle dieci ore alla settimana sia per scrivere nuovi contenuti sia per modificare e riutilizzare i contenuti esistenti della Guida per creare la Guida di LibreOffice online (LOOL). Alla velocità con cui normalmente scrivo e dedico dalle otto alle dieci ore a settimana, mi aspetto di produrre una guida di circa 200 pagine o più.
Utilizzo queste applicazioni da quando sono state StarOffice e sono molto esperto nell'uso delle funzionalità avanzate delle versioni desktop, tra cui:
- Stili in tutte le applicazioni
- Documenti master, riferimenti incrociati, figure e concetti di desktop publisher in Writer
- Grafici, grafici e strumenti di analisi dei dati in Calc
- Funzionalità delle presentazioni interattive, come transizioni e animazioni in Impressioni
Ho utilizzato ampiamente queste versioni desktop sia al lavoro che nel mio tempo libero.
Con questa guida scelgo come target l'utente di livello medio-tecnico, poiché molto probabilmente si tratta di persone che hanno le capacità, la pazienza e, soprattutto, l'interesse per iniziare a usare qualcosa come LOOL. In termini di riferimento, sarebbe ovviamente presente un contenuto didattico semplice (ad es. come applicare il grassetto a una selezione di testo), ma è necessario presupporre la comprensione di alcuni concetti tecnici (ovvero che un server web è responsabile della distribuzione dell'applicazione a un browser).
Dal punto di vista della pianificazione, all'inizio vorrei affrontare il progetto seguendo la pianificazione riportata di seguito. Nota: l'ordine in cui scriverò i capitoli non implica necessariamente la loro posizione nella Guida finale.
Settimana 1: Inizia a esplorare le istruzioni di installazione, Testa vari metodi di installazione, Esplora l'applicazione
L'obiettivo di questa settimana sarà un'installazione funzionante di LOOL. In base alla mia esperienza, scoprire tutti i tanti piccoli momenti in cui documentare questi tipi di applicazioni richiede un investimento di tempo. Questa settimana cercherei di esaminarli fino al punto in cui potrei installare facilmente l'applicazione utilizzando qualsiasi metodo disponibile senza essere infastidito da questi ostacoli.
Settimana 2: esegui installazioni di riferimento, metodi di installazione dei documenti
Questa settimana ci occuperemo della creazione di un elenco approssimativo di istruzioni di installazione (non in formato completo, ma piuttosto "in base ai numeri") e di una serie di note da includere nei capitoli successivi.
Settimana 3: Scrivere i capitoli della prefazione - Premessa, Introduzione, Informazioni su questa guida, ecc.
L'obiettivo di questa settimana sarà avere uno o più capitoli completi ed elaborati contenenti tutte le informazioni pertinenti di cui il lettore ha bisogno prima di eseguire l'installazione effettiva.
Settimana 4: scrivi i capitoli per l'installazione, parte 1
L'obiettivo di questa settimana sono istruzioni di installazione complete ed perfezionate per alcuni dei metodi disponibili, in formato standard dei capitoli della Guida di LibreOffice, ma in un formato che potrebbe essere facilmente riutilizzato, ad esempio per il wiki.
Settimana 5: scrivi i capitoli per l'installazione, parte 2
L'obiettivo di questa settimana sono istruzioni di installazione complete ed perfezionate per i metodi rimanenti, nel formato standard dei capitoli della Guida di LibreOffice, ma in un formato che possa essere facilmente riutilizzato, ad esempio per il wiki.
Settimana 6: scrivi il capitolo della configurazione post-installazione
L'obiettivo di questa settimana è completare e perfezionare i capitoli sulla configurazione post-installazione, ad esempio l'impostazione delle preferenze per l'applicazione (ad es. il fuso orario), la configurazione degli utenti e altre preparazioni che un amministratore deve preparare prima di mettere in produzione il sistema.
Settimana 7: scrivi capitoli relativi a navigazione, interfaccia e gestione dei file
L'obiettivo di questa settimana saranno capitoli completi ed elaborati che, una volta letta, renderanno il lettore familiare e a suo agio a lavorare nell'interfaccia utente.
Settimana 8: Scrittura dei capitoli su Writer (elaborazione di testi)
Questa settimana i capitoli completi e rifiniti dovrebbero consentire a un utente di creare documenti con uno stile accattivante direttamente nell'app.
Settimana 9: Scrittura dei capitoli di Calc (foglio di lavoro)
L'obiettivo di questa settimana è costituito dai capitoli completi e perfezionati che consentono all'utente di creare fogli di lavoro funzionali, tra cui la selezione di formule e grafici/grafici supportati.
Settimana 10: Capitoli Scrivi Impressione (presentazione)
L'obiettivo di questa settimana sarà quello o dei capitoli completi e perfezionati che consentiranno all'utente di creare una presentazione interattiva con la possibilità di riprodurla offline e di presentare dal vivo.
Settimana 11: scrivi i capitoli dell'integrazione
L'obiettivo della settimana 11 è completo e i capitoli curati forniscono all'utente un quadro completo delle opzioni di integrazione disponibili. Le indicazioni specifiche per l'integrazione delle app saranno probabilmente sotto forma di link a risorse pertinenti, ad esempio le pagine wiki su Document Foundation e/o i progetti integrati.
Settimana 12: Assemblaggio di elementi vari (appendici, indici, tabelle di figure, ecc.), Modifica/Correzione bozza 1st Pass
Alla fine di questa settimana dovrebbe essere disponibile una Guida completa con contenuti quasi finali ed elementi intatti/funzionanti come i riferimenti incrociati.
Settimana 13: Modifica/Correzione bozza 2nd Pass, Controlla set di tipi/Layout, Invia
Nell'ultima settimana verrà inviata una Guida completa e definitiva, modificata sia per i contenuti che per la presentazione.