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:
- Krezhairo
- Nome progetto:
- Guida di riferimento e guida dell'utente di Calc Functions
- Durata del progetto:
- Durata standard (3 mesi)
Project description
RICHIESTA DI PROGETTO
Posso dedicare facilmente 30-35 ore alla settimana durante la fase di scrittura tecnica e 10-12 ore in fase di pre-scrittura ad apprendere qualsiasi ulteriore competenza necessaria per il progetto. Vorrei informarti che attualmente vivo nella mia università(nel mio paese di origine), dove ho accesso a internet veloce e a qualsiasi risorsa aggiuntiva necessaria per il progetto e continuerò dalla mia università stessa per l'intera durata del progetto poiché siamo in COVID-19.
INTRODUZIONE
LibreOffice Calc ha un lungo elenco (+ 500) di funzioni in molte categorie per le quali la documentazione è abbastanza superficiale (ma nonostante la precisa) nella Guida. La procedura guidata per le funzioni integrata di Calc fornisce inoltre all'utente informazioni di riepilogo sullo scopo e sui parametri di ogni funzione. È stata creata una struttura sul wiki di The Document Foundation per acquisire informazioni di riferimento più dettagliate sulle funzioni di Calc.
OBIETTIVO
Per compilare la struttura wiki scrivendo contenuti più dettagliati per ciascuna delle funzioni di Calc, è stato utile segnalare l'ottemperanza allo standard ODFF, inclusi illustrazioni e diagrammi, fornendo uno o due esempi per indicare casi d'angolo ed eccezioni e fornendo file di esempio/esempio.
PIANO DI LAVORO DEL PROGETTO
Ho esaminato a fondo l'idea alla base del progetto e stiamo essenzialmente cercando di documentare il lavoro di ogni funzione nella procedura guidata delle funzioni e insieme a esempi sufficienti per ciascuna che coprano tutti gli aspetti delle funzioni e provare a rendere la documentazione il più intuitiva possibile in modo che un nuovo utente possa cercarla e capire in pochi secondi come utilizzarla.
Prenderei in considerazione di dividere queste funzioni per categorie:
• Database: This section deals with functions used with data organized as one row of data for one record.
• Date & Time: These spreadsheet functions are used for inserting and editing dates and times.
• Financial: This category contains the mathematical finance functions of LibreOffice Calc.
• Information: This category contains Information functions.
• Logical: This category contains Logical functions.
• Mathematical: This category contains the Mathematical functions for Calc.
• Array: This category contains the array functions.
• Statistical: This category contains Statistics functions.
• Spreadsheet: This section contains descriptions of the Spreadsheet functions together with an example.
• Text: This section contains descriptions of the Text functions.
• Add-in: The following describes and lists some of the available add-in functions.
Ognuno ha circa 20-50 funzioni con poche categorie che ne hanno più. La maggior parte include una descrizione superficiale con sintassi e un esempio.
Vorrei aggiungere contenuti più dettagliati per ciascuna delle funzioni di Calc, segnalando la conformità allo standard ODFF, includendo illustrazioni e diagrammi se utili, fornendo uno o due esempi per indicare casi d'angolo ed eccezioni sotto forma di commenti e fornire file di esempio/esempio. Inoltre, aggiungi una sezione importante quando è utile. Considererò queste funzioni in formato categorico, scegliendone una e lavorando in verticale per poi passare a un'altra categoria durante il periodo di scrittura tecnica. Inoltre, prenderei in considerazione l'idea di abituarsi all'ambiente di lavoro durante il periodo di legame con la comunità per semplificare le cose durante la fase di scrittura. In base alla mia esperienza, scoprire tutti quei piccoli momenti in cui documentare questi tipi di applicazioni richiede un investimento di tempo. Dal punto di vista della pianificazione, all'inizio consiglierei il progetto affrontando queste 11 categorie su cui lavorare. Naturalmente, alcune avranno bisogno di più assistenza e quindi richiederanno più tempo di altre, ma questi aspetti possono essere affrontati durante il lavoro. Poiché esiste già della documentazione e ti scrivo per iniziare, considererò la revisione di bozze al termine dell'attività di ogni settimana, dato che non è consigliabile lasciarla per l'ultima settimana.
Di seguito è riportata una programmazione indicativa per organizzare il progetto entro i limiti di tempo.
- Settimana 1:(14 settembre) • Database
- Settimana 2:(21 settembre) • Data e ora
- Settimana 3:(28 settembre) • Finanza
- Settimana 4:(05 ott) • Informazioni
- Settimana 5:(12 ott) • Logica
- Settimana 6:(19 ott) • Matematica
- Settimana 7:(26 ott) • Array
- Settimana 8:(2 novembre) • Statistica
- Settimana 9:(9 nov) • Foglio di lavoro
- Settimana 10:(16 nov) • SMS
- Settimana 11:(23 nov) • Componente aggiuntivo
- Settimana 12:(30 nov - 5 dic)(finale)
Documentare il lavoro svolto e l'esperienza maturata con questo progetto e lavorare su aspetti minori includevano la correzione/modifica di bozze di secondo passaggio, se necessario, per preparare la documentazione per l'invio.