Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- LibreOffice
- Technischer Redakteur:
- Krezhairo
- Projektname:
- Referenz und Nutzerhandbuch für Google Tabellen-Funktionen
- Projektdauer:
- Standardlaufzeit (3 Monate)
Projektbeschreibung
PROJEKTANFRAGE
Während der Phase des technischen Schreibens kann ich problemlos 30 bis 35 Stunden pro Woche und in der Vorschreibphase 10 bis 12 Stunden aufwenden, um zusätzliche Fähigkeiten für das Projekt zu erlernen. Ich möchte Sie darüber informieren, dass ich derzeit an meiner Universität(in meinem Heimatland) lebe, wo ich Zugang zu schnellem Internet und allen für das Projekt erforderlichen Add-on-Ressourcen habe. Ich werde die gesamte Projektdauer über an meiner Universität arbeiten, da ich aufgrund der COVID-19-Situation nicht davon ausgehe, dass meine Universität bald wieder startet. Selbst wenn das der Fall wäre, befinde ich mich im letzten Jahr meines Studiums, in dem ich nur 5 bis 6 Stunden pro Woche am Unterricht teilnehmen muss. Das würde sich also in keiner Weise auf das Projekt auswirken.
EINFÜHRUNG
LibreOffice Calc bietet eine umfangreiche Liste (über 500) von Funktionen in vielen Kategorien, für die die Dokumentation in der Hilfe recht oberflächlich (aber dennoch korrekt) ist. Der integrierte Funktionsassistenten von Calc stellt dem Benutzer zusammenfassende Informationen über den Zweck und die Parameter der einzelnen Funktionen bereit. Im Wiki von The Document Foundation wurde eine Struktur erstellt, um detailliertere Referenzinformationen zu den Funktionen von Calc zu erfassen.
ZIEL
Um die Wiki-Struktur mit detaillierteren Inhalten für jede der Funktionen von Google Tabellen zu füllen, war es hilfreich, die Einhaltung des ODFF-Standards zu kennzeichnen, einschließlich Abbildungen und Diagrammen, ein oder zwei Beispiele für Grenzfälle und Ausnahmen anzugeben und Beispieldateien bereitzustellen.
PROJEKTARBEITSPLAN
Ich habe mich mit dem Grundgedanken des Projekts vertraut gemacht. Wir versuchen im Grunde, die Funktionsweise jeder Funktion im Funktionsassistenten sowie ausreichende Beispiele für jede einzelne Funktion zu dokumentieren, die alle Aspekte der Funktionen abdeckt. Versuchen Sie, die Dokumentation so intuitiv wie möglich zu gestalten, damit neue Nutzende nachschlagen können und in Sekundenschnelle verstehen, wie sie verwendet wird.
Ich würde überlegen, diese Funktionen in Kategorien zu 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, es gibt aber nur wenige Kategorien. Die meisten enthalten eine kurze Beschreibung mit Syntax und einem Beispiel.
Ich würde gerne detailliertere Inhalte für jede der Funktionen von Calc hinzufügen, die Einhaltung des ODFF-Standards melden, einschließlich Abbildungen und Diagrammen, wo immer hilfreich ist, ein oder zwei Beispiele anführen, um Sonderfälle und Ausnahmen in Form von Anmerkungen anzugeben, und Beispiel-/Beispieldateien zur Verfügung stellen. Außerdem wird ein wichtiger Abschnitt hinzugefügt, falls dies sinnvoll ist. Ich werde diese Funktionen in kategorischem Format durchgehen, d.h. eine auswählen und vertikal arbeiten und dann während der Phase des technischen Schreibens zu einer anderen Kategorie übergehen. Außerdem würde ich mich in der Phase des Kennenlernens mit der Arbeitsumgebung vertraut machen, um die Schreibphase zu erleichtern. Meiner Erfahrung nach erfordert es Zeit, alle kleinen „Aha-Momente“ zu entdecken, die beim Dokumentieren dieser Art von Anwendungen auftreten. Bei der Planung würde ich zu Beginn des Projekts diese 11 Kategorien durchgehen, an denen ich arbeiten möchte. Natürlich benötigen einige mehr Unterstützung und damit mehr Zeit als andere, aber diese Dinge können während der Arbeit angegangen werden. Da es bereits einige Dokumentationen gibt und ich darauf aufbauend schreibe, werde ich die Korrekturlesen nach Abschluss der Aufgabe jeder Woche in Betracht ziehen, da es nicht gut ist, dies auf die letzte Woche zu verschieben.
Nachfolgend finden Sie einen groben Zeitplan für die Organisation des Projekts innerhalb der zeitlichen Grenzen.
- Woche 1:(14. September) • Datenbank
- Woche 2:(21. September) • Datum und Uhrzeit
- Woche 3:(28. September) • Finanzen
- Woche 4:(05. Oktober) • Informationen
- Woche 5:(12. Oktober) • Logisch
- Woche 6:(19. Oktober) • Mathematische
- Woche 7:(26. Okt.) • Array
- Woche 8:(2. Nov.) • Statistische
- Woche 9:(9. Nov.) • Tabelle
- Woche 10:(16. Nov.) • SMS
- Woche 11:(23. Nov.) • Add-in
- Woche 12:(30. Nov. bis 5. Dez.)(endgültig)
Die Dokumentation der geleisteten Arbeit und der Erfahrungen aus diesem Projekt sowie die Bearbeitung kleinerer Dinge umfasste bei Bedarf eine zweite Korrekturlesen/Bearbeitung, um die Dokumentation zur Einreichung vorzubereiten.