Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- LibreOffice
- Technischer Redakteur:
- Krezhairo
- Projektname:
- Referenz und Nutzerhandbuch zu Kalkfunktionen
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
PROJEKTANFRAGE
Ich kann problemlos 30 bis 35 Stunden pro Woche für die technische Schreibphase und 10 bis 12 Stunden in die Vorformulierungsphase aufwenden, um die für das Projekt erforderlichen Fähigkeiten zu erlernen. Ich möchte Sie darüber informieren, dass ich an meiner Universität(in meinem Heimatland) wohne, an der ich Zugang zu schnellem Internet und allen für das Projekt benötigten Add-on-Ressourcen habe. Da wir in COVID-19 sind, werde ich von meiner Universität selbst aus weitermachen, da wir COVID-19 haben. Die Situation, dass meine Universität nicht so bald beginnt, und auch wenn sie in meinem letzten Jahr ist, würde ich die Kurse nur 5–6 Stunden lang besuchen.
EINFÜHRUNG
LibreOffice Calc hat eine umfassende Liste von Funktionen in vielen Kategorien (+ 500), für die die Dokumentation in der Hilfe recht flach (aber dennoch korrekt) ist. Mit dem in Calc integrierten Funktionsassistenten erhalten Nutzer außerdem zusammenfassende Informationen zum Zweck und zu den Parametern der einzelnen Funktionen. Im Wiki der Document Foundation wurde eine Struktur erstellt, um detailliertere Referenzinformationen zu den Calc-Funktionen zu erfassen.
ZIEL
Um die Wiki-Struktur durch das Schreiben detaillierterer Inhalte für jede der Calc-Funktionen zu füllen, war die Kennzeichnung der Einhaltung des ODFF-Standards einschließlich Illustrationen und Diagrammen hilfreich. Es gab ein oder zwei Beispiele zur Angabe von Sonderfällen und Ausnahmen sowie die Bereitstellung von Beispiel-/Beispieldateien.
PROJEKTARBEITSPLAN
Ich habe mir die Kernidee des Projekts genau angesehen und wir versuchen im Wesentlichen, die Funktionsweise jeder Funktion im Funktionsassistenten zu dokumentieren, zusammen mit ausreichenden Beispielen für jede Funktion, die alle Aspekte der Funktionen abdeckt. Versuchen Sie, die Dokumentation so intuitiv wie möglich zu gestalten, damit ein neuer Nutzer in Sekundenschnelle nachschlagen und die Verwendung verstehen kann.
Ich würde diese Funktionen gegebenenfalls durch Kategorien unterteilen:
• 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.
Jede hat etwa 20 bis 50 Funktionen, nur wenige Kategorien umfassen mehr. Die meisten von ihnen enthalten eine oberflächliche Beschreibung mit Syntax und ein Beispiel.
Ich möchte zu jeder der Calc-Funktionen detailliertere Inhalte hinzufügen und die Einhaltung des ODFF-Standards kennzeichnen, einschließlich Illustrationen und Diagrammen, sofern hilfreich, ein oder zwei Beispiele zur Angabe von Eckfällen und Ausnahmen in Form von Bemerkungen sowie Beispiel-/Beispieldateien. Fügen Sie außerdem einen wichtigen Abschnitt hinzu, wenn er nützlich ist. Ich werde diese Funktionen in einem kategorialen Format durchgehen, d.h. ich werde eine Funktion wählen, vertikal arbeiten und dann während der technischen Schreibphase in eine andere Kategorie wechseln. Außerdem würde ich mich in der Phase der Beziehung zur Community an meine Arbeitsumgebung gewöhnen, um die Arbeit während der Schreibphase zu vereinfachen. Ich habe die Erfahrung gemacht, dass es viel Zeit kostet, all die vielen kleinen Momente der Dokumentation solcher Anwendungen zu entdecken. Was die Planung angeht, würde ich zu Beginn an das Projekt herangehen, indem ich diese 11 Kategorien durchläuft. Natürlich benötigen einige mehr Unterstützung und benötigen daher mehr Zeit als andere, aber diese Dinge können während der Arbeit angegangen werden. Da es bereits eine Dokumentation gibt und ich darauf schreibe, überlege ich mir, ob ich nach jeder Woche Korrekturlesen in Betracht ziehen sollte, da es nicht gut ist, sie in der letzten Woche stehen zu lassen.
Unten finden Sie einen groben Zeitplan für die Organisation des Projekts innerhalb der zeitlichen Grenzen.
- Woche 1:(14. September) • Datenbank
- Woche 2:(21. Sept.) • Datum und Uhrzeit
- Woche 3:(28. September) • Finanzen
- Woche 4:(5. Okt.) • Informationen
- Woche 5:(12. Okt.) • Logisch
- Woche 6:(19. Okt.) • Mathematische Daten
- Woche 7:(26. Okt.) • Array
- Woche 8:(2. Nov.) • Statistik
- Woche 9:(9. Nov.) • Tabelle
- Woche 10:(16. Nov.) • Text
- Woche 11:(23. Nov.) • Add-in
- Woche 12:(30. Nov. bis 5. Dez.)(finale Version)
Die Dokumentation der geleisteten Arbeit und der aus diesem Projekt gewonnenen Erfahrungen und die Arbeit an kleineren Dingen beinhaltete ggf. das zweite Korrekturlesen/Bearbeiten von Korrekturmaßnahmen, um die Dokumentation für die Einreichung vorzubereiten.