Diese Seite enthält die Details eines Projekts für technisches Schreiben, das für die Google-Staffel von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- LibreOffice
- Technischer Redakteur:
- Quffein
- Projektname:
- LibreOffice-Onlineleitfaden: ein ähnlicher Leitfaden für andere LO-Anwendungen – nicht nur zur Nutzung, sondern auch zur Installation und Verwaltung
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Wenn ich ausgewählt werde, würde ich acht bis zehn Stunden pro Woche damit aufwenden, sowohl neue Inhalte zu schreiben als auch vorhandene Inhalt des Leitfadens zu bearbeiten und für die Erstellung des LibreOffice Online (LOOL)-Handbuchs umzufunktionieren. Bei dem Tempo, in dem ich normalerweise schreibe und es zwischen acht und zehn Stunden pro Woche aufwende, würde ich erwarten, eine Übersicht mit einer Länge von etwa 200 Seiten oder mehr zu erstellen.
Ich verwende diese Anwendungen seit StarOffice und bin bestens mit den erweiterten Funktionen der Desktop-Versionen vertraut, darunter:
- Stile in allen Anwendungen
- Dokumente, Querverweise, Abbildungen und Desktop-Publishing-Konzepte in Writer lernen
- Diagramme, Grafiken und Datenanalysetools in Calc
- Interaktive Präsentationsfunktionen wie Übergänge und Animationen in Impress
Ich habe diese Desktop-Versionen sowohl bei der Arbeit als auch in meiner Freizeit intensiv verwendet.
Dieser Leitfaden richtet sich an Nutzer mit weniger technischem Hintergrund, da es sich dabei höchstwahrscheinlich um die Personen handelt, die über die Fähigkeiten, die Geduld und vor allem das Interesse daran haben, LOOL zum Laufen zu bringen. Als Referenz verfügt sie natürlich über einfache Anleitungen (z. B. wie eine Textauswahl fett formatiert werden kann). Es ist jedoch vorausgesetzt, dass sie einige technische Konzepte kennt (z. B. dass ein Webserver für die Bereitstellung der Anwendung an einen Browser verantwortlich ist).
Was die Planung angeht, würde ich das Projekt zu Beginn nach dem folgenden Zeitplan angehen, der unten beschrieben wird. Hinweis: Die Reihenfolge, in der ich die Kapitel aufschreiben würde, deutet nicht unbedingt auf ihren Standort im endgültigen Leitfaden hin.
Woche 1: Installationsanleitung ansehen, verschiedene Installationsmethoden testen, Anwendung kennenlernen
Ziel dieser Woche ist es, eine funktionierende Installation von LOOL zu haben. Meiner Erfahrung nach ist es zeitaufwendig, all die vielen kleinen „Verstanden“-Momente bei der Dokumentation solcher Anwendungen zu finden. Ich würde versuchen, diese Woche so lange durchzugehen, dass ich die App mit jeder verfügbaren Methode problemlos installieren kann, ohne diese Schwierigkeiten zu überwinden.
Woche 2: Referenzinstallationen durchführen und Installationsmethoden dokumentieren
Diese Woche würde man damit rechnen, eine grobe Liste von Installationsanweisungen zusammenzustellen (nicht in vollständigem Format, sondern "in Zahlen") und eine Reihe von Notizen, die in späteren Kapiteln aufgenommen werden.
Woche 3: Kapitel des Vorworts schreiben – Vorwort, Einführung, Über dieses Handbuch usw.
Ziel dieser Woche ist es, ein oder mehrere vollständige, ausgearbeitete Kapitel mit allen relevanten Informationen zu haben, die die Lesenden benötigen, bevor sie die eigentliche Installation vornehmen.
Woche 4: Kapitel zur Installation schreiben, Teil 1
Ziel dieser Woche ist es, vollständige, ausgefeilte Installationsanleitungen für einige der verfügbaren Methoden im Standardformat des LibreOffice Guide-Kapitels bereitzustellen, aber in einer Form, in der sie einfach wiederverwendet werden können, z.B. für das Wiki.
Woche 5: Kapitel zur Installation schreiben, Teil 2
Ziel dieser Woche ist es, vollständige, ausgefeilte Installationsanleitungen für die restlichen Methoden im Standardformat des LibreOffice Guide-Kapitels bereitzustellen, jedoch in einer Form, in der sie problemlos wiederverwendet werden können, z.B. für das Wiki.
Woche 6: Kapitel zur Konfiguration nach der Installation schreiben
Das Ziel dieser Woche sind vollständige, ausgearbeitete Kapitel zur Konfiguration nach der Installation, wie das Einrichten von Einstellungen für die Anwendung (z.B. Zeitzone), das Einrichten von Nutzern und andere Vorbereitungen, die ein Administrator vor der Einführung des Systems in die Produktion ergreifen würde.
Woche 7: Kapitel zu Navigation, Benutzeroberfläche und Dateiverwaltung schreiben
Ziel dieser Woche ist es, vollständige, ausgefeilte Kapitel zu erstellen, die den Lesenden nach dem Lesen vertraut machen und ihnen die Arbeit mit der Benutzeroberfläche erleichtern.
Woche 8: Kapitel des Autors schreiben (Textverarbeitung)
Diese Woche sollten vollständige, ausgefeilte Kapitel enthalten sein, mit denen Nutzer direkt in der App ansprechend gestaltete Dokumente erstellen können.
Woche 9: Kapitel in der Kalkulation schreiben
Vollständige, ausgearbeitete Kapitel, in denen Nutzende funktionale Tabellen erstellen können, einschließlich der Auswahl unterstützter Formeln und Diagramme/Grafiken sind das Ziel dieser Woche.
Woche 10: Kapitel zu Impressum (Präsentation) schreiben
Ziel dieser Woche ist es, vollständige, ausgefeilte Kapitel zu erstellen, in denen Nutzende eine interaktive Präsentation erstellen können, die sie auch zur Offline-Nutzung sowie zur Live-Präsentation ausgeben können.
Woche 11: Kapitel zur Integration schreiben
Das Ziel von Woche 11 ist ein vollständiges, ausgefeiltes Kapitel, in dem Sie den Nutzenden ein vollständiges Bild der verfügbaren Integrationsoptionen vermitteln. Die spezifische Anleitung für die Integration der Anwendungen erfolgt wahrscheinlich in Form von Links zu relevanten Ressourcen wie Wiki-Seiten bei der Document Foundation und/oder den integrierten Projekten.
Woche 12: Verschiedene Elemente zusammenstellen (Anhänge, Indizes, Zahlentabellen usw.), 1. Pass – Bearbeiten/Korrekturlesen
Am Ende dieser Woche sollte es einen vollständigen Leitfaden mit nahezu finalen Inhalten und intakten/funktionierenden Elementen wie Querverweisen geben.
Woche 13: 2. Pass – Korrektur/Korrekturlesen, Typ/Layout prüfen, Senden
In dieser letzten Woche wird ein vollständiger und finaler Leitfaden eingereicht, der sowohl für den Inhalt als auch für die Präsentation bearbeitet wurde.