Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per Google Season of Docs.
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 verrà selezionato, ho in programma di dedicare dalle otto alle dieci ore alla settimana sia per scrivere nuovi contenuti sia per modificare e riadattare i contenuti esistenti della Guida per creare la Guida di LibreOffice Online (LOOL). Al ritmo che solitamente 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 StarOffice e sono abituato all'uso delle funzioni avanzate delle versioni desktop, tra cui:
- Stili in tutte le applicazioni
- Documenti master, riferimenti incrociati, figure e concetti di desktop Publishing in Writer
- Grafici, grafici e strumenti di analisi dei dati in Calc
- Funzionalità di presentazioni interattive come transizioni e animazioni in Impress
Ho utilizzato ampiamente queste versioni desktop sia per il lavoro che nel mio tempo libero.
Con questa guida sceglierei come target l'utente di livello tecnico medio, poiché molto probabilmente si tratta di persone che hanno le competenze, la pazienza e, soprattutto, l'interesse per ottenere qualcosa come LOOL attivo e funzionante. In termini di riferimento, sarebbe ovviamente presente un contenuto didattico semplice (ad es. come applicare il grassetto a una selezione di testo), ma si dovrebbe presupporre la comprensione di alcuni concetti tecnici (ovvero che un server web è responsabile della fornitura dell'applicazione a un browser).
Per quanto riguarda la pianificazione, all'inizio consiglierei il progetto seguendo il programma riportato 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 tanti e piccoli momenti in cui documentare questi tipi di applicazioni richiede un investimento di tempo. Cercherò di esaminarli questa settimana fino al punto in cui potrei installare facilmente l'applicazione utilizzando qualsiasi metodo disponibile senza bloccarmi con questi ostacoli.
Settimana 2: Esegui installazioni di riferimento, metodi di installazione dei documenti
Questa settimana sarebbe stata dedicata alla preparazione di un elenco approssimativo di istruzioni di installazione (non in un formato completamente scritto, ma piuttosto "in base ai numeri") e a una serie di note da includere nei capitoli successivi.
Settimana 3: Scrivi i capitoli della prefazione - Premessa, introduzione, Informazioni sulla guida ecc.
L'obiettivo di questa settimana sarà quello di 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 dell'installazione, Parte 1
L'obiettivo di questa settimana è fornire istruzioni di installazione complete e accurate per alcuni dei metodi disponibili, nel 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 dell'installazione, Parte 2
L'obiettivo di questa settimana è fornire istruzioni di installazione complete e accurate per i restanti metodi, nel formato standard dei capitoli della guida di LibreOffice, ma in un formato che potrebbe essere facilmente riutilizzato, ad esempio per il wiki.
Settimana 6: Scrivi il capitolo sulla 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 farebbe prima di mettere in produzione il sistema.
Settimana 7: Scrivi capitoli relativi a navigazione, interfaccia e gestione dei file
L'obiettivo di questa settimana sarà comprendere capitoli completi ed eleganti che, una volta letti, renderanno il lettore familiare e a suo agio a lavorare nell'interfaccia utente.
Settimana 8: Writer (Word Processing) Capitoli
Questa settimana dovrebbe essere un o più capitoli completi e rifiniti che consentiranno all'utente di creare documenti con uno stile accattivante direttamente nell'app.
Settimana 9: Scrivi capitoli di calcolo (foglio di lavoro)
L'obiettivo di questa settimana è costituito dai capitoli completi e rifiniti che consentono a un utente di creare fogli di lavoro funzionali, inclusa la selezione di formule e grafici/grafici supportati.
Settimana 10: Scrivi Impressioni (presentazione) capitoli
L'obiettivo di questa settimana sarà quello di completare e perfezionare i capitoli, per consentire a un utente di creare una presentazione interattiva con la possibilità di riprodurla offline e di presentarla dal vivo.
Settimana 11: Scrivi capitoli sull'integrazione
L'obiettivo della settimana 11 è composto da capitoli completi che forniscono all'utente un quadro completo delle opzioni di integrazione disponibili. Le indicazioni specifiche per l'integrazione delle app sarebbero probabilmente sotto forma di link a risorse pertinenti, ad esempio pagine wiki nella Document Foundation e/o ai progetti integrati.
Settimana 12: Combina elementi vari (appendici, indici, tabelle di figure, ecc.), Modifica/Correzione bozza 1° pass
Alla fine di questa settimana dovrebbe essere disponibile una Guida completa con contenuti quasi definitivi ed elementi intatti/funzionanti come i riferimenti incrociati.
Settimana 13: Modifica/Correzione bozza, Controlla set di tipi/Layout, Invia
Quest'ultima settimana vedrà l'invio di una Guida completa e finale, modificata sia per i contenuti che per la presentazione.