Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- LibreOffice
- Redattore tecnico:
- quaffeine
- Nome del progetto:
- Guida di LibreOffice Online: una guida simile a quelle utilizzate 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 selezionata, prevedi di dedicare 8-10 ore a settimana alla scrittura di nuovi contenuti, nonché alla modifica e al riutilizzo dei contenuti esistenti della guida per creare la guida di LibreOffice Online (LOOL). Al ritmo con cui scrivo normalmente e dedicando tra otto e dieci ore alla settimana, mi aspetto di produrre una guida di circa 200 pagine o più.
Utilizzo queste applicazioni da quando erano StarOffice e ho una buona esperienza nell'utilizzo delle funzionalità avanzate delle versioni desktop, tra cui:
- Stili nelle varie applicazioni
- Documenti principali, riferimenti incrociati, figure e concetti di desktop publishing in Writer
- Grafici, tabelle e strumenti di analisi dei dati in Calc
- Funzionalità di presentazione interattiva come transizioni e animazioni in Impress
Ho usato molto queste versioni desktop sia al lavoro che nel tempo libero.
Con questa guida mi rivolgo agli utenti con competenze tecniche medie, in quanto sono le persone che hanno le competenze, la pazienza e, soprattutto, l'interesse per configurare e utilizzare qualcosa come LOOL. In termini di riferimento, ovviamente avrà contenuti didattici semplici (ad es. come applicare il grassetto a una selezione di testo), ma occorre presumere la comprensione di alcuni concetti tecnici (ovvero che un server web è responsabile della pubblicazione dell'applicazione in un browser).
In termini di pianificazione, all'inizio mi atterrei al progetto secondo le linee della seguente pianificazione dettagliata 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à avere un'installazione funzionante di LOOL. In base alla mia esperienza, scoprire tutti i piccoli "problemi" che si verificano durante la documentazione di questi tipi di applicazioni richiede un investimento in termini di tempo. Cercherò di risolverli entro la fine della settimana in modo da poter installare facilmente l\'applicazione utilizzando qualsiasi metodo disponibile senza incappare in questi ostacoli.
Settimana 2: esegui installazioni di riferimento, documenta i metodi di installazione
Questa settimana dedicheresti a stilare un elenco approssimativo di istruzioni di installazione (non in un formato completo, ma piuttosto "in cifre"") e una serie di note da includere nei capitoli successivi.
Settimana 3: scrivi i capitoli della prefazione: introduzione, presentazione, Informazioni sulla guida e così via.
L'obiettivo di questa settimana sarà avere uno o più capitoli completi e perfezionati contenenti tutte le informazioni pertinenti di cui un lettore ha bisogno prima di intraprendere l'installazione effettiva.
Settimana 4: scrivere i capitoli sull'installazione, parte 1
L'obiettivo di questa settimana sono istruzioni di installazione complete e accurate per alcuni dei metodi disponibili, nel formato standard dei capitoli della Guida di LibreOffice, ma in un formato in cui possano essere facilmente riutilizzati, ad esempio per il wiki.
Settimana 5: scrivere i capitoli sull'installazione, parte 2
L'obiettivo di questa settimana è completare e perfezionare le istruzioni di installazione per i metodi rimanenti, nel formato standard del capitolo della Guida di LibreOffice, ma in un formato in cui possano essere facilmente riutilizzati, ad esempio per la wiki.
Settimana 6: scrivere il capitolo sulla configurazione post-installazione
L'obiettivo di questa settimana è completo, capitoli curati sulla configurazione post-installazione, quali l'impostazione delle preferenze per l'applicazione (ad es. il fuso orario), la configurazione degli utenti e altre preparazioni che un amministratore potrebbe eseguire prima di mettere il sistema in produzione.
Settimana 7: scrivi i capitoli relativi a navigazione, interfaccia e gestione dei file
L'obiettivo di questa settimana sarà completare capitoli perfezionati che, una volta letti, aiuteranno il lettore a familiarizzare con l'interfaccia utente e a utilizzarla in tutta sicurezza.
Settimana 8: scrittura dei capitoli dello scrittore (elaborazione di testi)
Questa settimana dovrebbero essere disponibili capitoli completi e perfezionati che consentono a un utente di creare documenti con un'estetica accattivante direttamente nell'app.
Settimana 9: scrivere i capitoli di Calc (foglio di lavoro)
L'obiettivo di questa settimana è creare capitoli completi e perfezionati che consentano a un utente di creare fogli di lavoro funzionali, inclusa la selezione di formule e grafici/grafici supportati.
Settimana 10: Capitoli della scrittura delle impressioni (presentazione)
L'obiettivo di questa settimana sarà creare capitoli completi e perfezionati che consentano a un utente di creare una presentazione interattiva con la possibilità di esportarla per la visualizzazione offline e la presentazione dal vivo.
Settimana 11: scrivi i capitoli sull'integrazione
L'obiettivo della settimana 11 è completare e perfezionare i capitoli per fornire all'utente un quadro completo delle opzioni di integrazione disponibili. Le linee guida specifiche per l'integrazione delle app saranno probabilmente sotto forma di link a risorse pertinenti, ad esempio pagine wiki su Document Foundation e/o progetti integrati.
Settimana 12: Assemblare elementi vari (appendici, indici, tabelle di figure ecc.), 1a revisione/lettura bozza
Entro la fine di questa settimana dovrebbe essere disponibile una guida completa con contenuti quasi definitivi ed elementi integri/funzionanti come i riferimenti incrociati.
Settimana 13: 2a revisione/lettura bozza, verifica impaginazione/layout, invio
Quest'ultima settimana vedrà l'invio di una guida completa e finale, modificata sia per i contenuti che per la presentazione.