Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione di Documenti Google.
Riepilogo progetto
- Organizzazione open source:
- LibreOffice
- Redattore tecnico:
- Krezhairo
- Nome del progetto:
- Riferimento per le funzioni di calcolo e guida dell'utente
- Durata del progetto:
- Durata standard (3 mesi)
Project description
RICHIESTA DI PROGETTO
Posso dedicare facilmente 30-35 ore a settimana durante la fase di scrittura tecnica e 10-12 ore nella fase di pre-scrittura per apprendere qualsiasi aggiunta sulle competenze necessarie per il progetto. Ti informo che al momento vivo nel mio campus universitario(nel mio paese d'origine), dove ho accesso a una connessione a internet veloce e a qualsiasi risorsa aggiuntiva necessaria per il progetto. Continuerò a lavorare dall'università per l'intera durata del progetto, dato che siamo in piena emergenza COVID-19. Non credo che la mia università riaprirà a breve e, anche se lo facesse, sarei al mio ultimo anno e dovrei frequentare i corsi solo per 5-6 ore a settimana, quindi il progetto non ne risentirebbe in alcun modo.
INTRODUZIONE
LibreOffice Calc dispone di un ampio elenco (+ 500) di funzioni in molte categorie per le quali la documentazione è piuttosto superficiale (ma comunque accurata) nella Guida. La procedura guidata di funzione integrata di Calc fornisce inoltre all'utente informazioni di riepilogo sullo scopo e sui parametri di ciascuna funzione. Sul wiki di The Document Foundation è stata creata una struttura per acquisire informazioni di riferimento più dettagliate sulle funzioni di Calc.
OBIETTIVO
Per compilare la struttura della wiki scrivendo contenuti più dettagliati per ciascuna delle funzioni di Calc, è stato utile segnalare la conformità allo standard ODFF, includere illustrazioni e diagrammi, fornire uno o due esempi per indicare casi limite ed eccezioni e fornire file di esempio.
PIANO DI LAVORO DEL PROGETTO
Ho esaminato a fondo l'idea di base del progetto e stiamo sostanzialmente cercando di documentare il funzionamento di ogni funzione nella procedura guidata delle funzioni, oltre a fornire esempi sufficienti per ciascuna che coprano tutti gli aspetti delle funzioni e cercare di rendere la documentazione il più intuitiva possibile in modo che un nuovo utente possa consultarla e capire in pochi secondi come utilizzarla.
Ti consiglio di suddividere queste funzioni in 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.
Ognuna ha circa 20-50 funzioni, mentre alcune categorie ne hanno di più. La maggior parte include una descrizione superficiale con la sintassi e un esempio.
Vorrei aggiungere contenuti più dettagliati per ciascuna delle funzioni di Calc, segnalare la conformità allo standard ODFF, includere illustrazioni e diagrammi ove utile, fornire uno o due esempi per indicare casi limite ed eccezioni sotto forma di osservazioni e fornire file di esempio. Inoltre, aggiungi una sezione importante dove utile. Prenderò in considerazione la possibilità di utilizzare queste funzioni in formato categorico, ovvero sceglierne una e lavorare in verticale, per poi passare a un'altra categoria durante il periodo di stesura della documentazione tecnica. Inoltre, ti consiglio di abituarti all'ambiente di lavoro durante il periodo di affiatamento con la community per semplificare la fase di scrittura. Secondo la mia esperienza, scoprire tutti i tanti piccoli momenti in cui documentare questo tipo di applicazioni richiede un investimento di tempo. Dal punto di vista della pianificazione, d'inizio mi conviene affrontare il progetto esaminando queste 11 categorie su cui lavorare. Ovviamente, alcune avranno bisogno di più assistenza e quindi richiederanno più tempo di altre, ma questi aspetti possono essere affrontati mentre si lavora. Dato che esiste già della documentazione e sto scrivendo sopra, prenderò in considerazione la correzione di bozze dopo che l'attività di ogni settimana sarà stata completata, perché non è bene lasciarla per l'ultima settimana.
Di seguito è riportata una programmazione approssimativa per organizzare il progetto nei limiti di tempo.
- Settimana 1 (14 settembre): • Database
- Settimana 2:(21 settembre) • Data e ora
- Settimana 3:(28 settembre) • Finanza
- Settimana 4:(5 ott) • Informazioni
- Settimana 5:(12 ott) • Logico
- Settimana 6:(19 ott) • Matematica
- Settimana 7:(26 ott) • Array
- Settimana 8:(2 novembre) • Statistiche
- Settimana 9:(9 nov) • Foglio di lavoro
- Settimana 10:(16 novembre) • Testo
- Settimana 11 (23 novembre): • Componente aggiuntivo
- Settimana 12:(30 nov – 5 dic)(definitiva)
Documentare il lavoro svolto e l'esperienza acquisita in questo progetto e lavorare su aspetti minori, inclusa la correzione/revisione di 2° passaggio, se necessario, per preparare la documentazione per l'invio.