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:
- Kuchen
- Projektname:
- LibreOffice-Onlineleitfaden: Ein Leitfaden, der dem für andere LO-Anwendungen verwendeten Leitfaden ähnelt und nicht nur die Nutzung, sondern auch die Installation und Verwaltung umfasst
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Wenn ich ausgewählt werde, würde ich acht bis zehn Stunden pro Woche dafür aufwenden, sowohl neue Inhalte zu schreiben als auch vorhandene Inhalte der Anleitung zu bearbeiten und für die Erstellung des LibreOffice Online (LOOL)-Handbuchs umzufunktionieren. Bei dem Tempo, in dem ich normalerweise acht bis zehn Stunden pro Woche aufwende, würde ich einen Leitfaden mit einer Länge von etwa 200 Seiten oder mehr erstellen.
Ich verwende diese Anwendungen, seit sie StarOffice sind, und ich kenne mich gut mit den erweiterten Funktionen der Desktop-Versionen aus, darunter:
- Stile in allen Anwendungen
- Dokumente, Querverweise, Abbildungen und Desktop-Publishing-Konzepte in Writer verwalten
- 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 technisch versierte Nutzer, da es sich hierbei höchstwahrscheinlich um die Personen handelt, die über die Fähigkeiten, die Geduld und das wichtigste Interesse verfügen, etwas wie LOOL zum Laufen zu bringen. Als Referenz verfügt sie natürlich über einfache Anleitungsinhalte (z. B. wie Sie eine Textauswahl fett formatieren). Es wird jedoch vorausgesetzt, dass Sie einige technische Konzepte kennen (d. h., dass ein Webserver für die Bereitstellung der Anwendung an einen Browser verantwortlich ist).
Was die Planung angeht, würde ich von Anfang an das Projekt gemäß dem folgenden Zeitplan angehen, der unten erläutert wird. Hinweis: Die Reihenfolge, in der ich die Kapitel schreiben sollte, bedeutet nicht unbedingt, dass sie sich im endgültigen Leitfaden befinden.
Woche 1: Installationsanleitung ansehen, verschiedene Installationsmethoden testen, Anwendung kennenlernen
Das Ziel dieser Woche ist es, eine funktionierende Installation von LOOL zu haben. Ich habe die Erfahrung gemacht, dass es viel Zeit kostet, all die vielen kleinen „Erwischen“-Momente bei der Dokumentation solcher Anwendungen zu entdecken. Ich würde diese Woche versuchen, die Apps so weit zu bearbeiten, dass ich die Anwendung problemlos mit jeder verfügbaren Methode installieren kann, ohne von diesen Hindernissen zu hängen.
Woche 2: Referenzinstallationen und Methoden zur Installation von Dokumenten durchführen
Diese Woche würde das Zusammenstellen einer groben Liste von Installationsanweisungen (nicht in schriftlicher Form, sondern in Form von Zahlen) und einer Reihe von Notizen in späteren Kapiteln erledigt werden.
Woche 3: Kapitel für die Vorbemerkungen verfassen – Vorwort, Einleitung, Info zu diesem Leitfaden usw.
Ziel dieser Woche ist es, mindestens ein vollständiges, ausgefeiltes Kapitel mit allen relevanten Informationen zu erstellen, die Leser benötigen, bevor sie die eigentliche Installation durchführen.
Woche 4: Kapitel zur Installation schreiben, Teil 1
Ziel dieser Woche ist es, eine vollständige und ausgefeilte Installationsanleitung für einige der verfügbaren Methoden im Standardformat für Kapitel des LibreOffice Guide zu erstellen, aber in einer Form, in der sie problemlos wiederverwendet werden können, z.B. für das Wiki.
Woche 5: Kapitel zur Installation schreiben, Teil 2
Ziel dieser Woche ist es, eine vollständige und ausgefeilte Installationsanleitung für die restlichen Methoden im Standardformat des LibreOffice Guide-Kapitels zu erstellen, aber in einer Form, in der sie problemlos wiederverwendet werden können, z.B. für das Wiki.
Woche 6: Kapitel „Konfiguration nach der Installation erstellen“
Das Ziel dieser Woche sind vollständige, ausgearbeitete Kapitel zur Konfiguration nach der Installation, z. B. das Einrichten von Einstellungen für die Anwendung (z. B. Zeitzone), das Einrichten von Nutzern und andere Vorbereitungen, die ein Administrator treffen würde, bevor er das System in die Produktion überführt.
Woche 7: Kapitel zu Navigation, Schnittstelle und Dateiverwaltung schreiben
Das Ziel dieser Woche sind vollständige, ausgefeilte Kapitel, die den Lesern 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, in denen Nutzer direkt in der App ansprechend gestaltete Dokumente erstellen können.
Woche 9: Kapitel in der Kalkulation (Tabelle) schreiben
Ziel dieser Woche ist es, vollständige, ausgefeilte Kapitel zu erstellen, in denen Nutzende funktionale Tabellen erstellen können, einschließlich der Auswahl unterstützter Formeln und Diagramme/Grafiken.
10. Woche: Kapitel für Impressumschreiben (Präsentation)
Das Ziel dieser Woche sind vollständige, ausgefeilte Kapitel, in denen Nutzende eine interaktive Präsentation erstellen können, die sie zur Offline-Nutzung sowie zur Live-Präsentation ausgeben kann.
Woche 11: Integrationskapitel schreiben
Das Ziel von Woche 11 sind vollständige, ausgearbeitete Kapitel, in denen die Nutzenden ein vollständiges Bild der verfügbaren Integrationsoptionen erhalten. Die spezifischen Hinweise für die Integration der Anwendungen sind wahrscheinlich in Form von Links zu relevanten Ressourcen wie Wiki-Seiten der Document Foundation und/oder den integrierten Projekten.
12. Woche: Verschiedene Elemente zusammenstellen (Anhänge, Indizes, Zahlentabellen usw.) 1. Pass – Bearbeite/Korrekturlesen
Am Ende dieser Woche sollte es ein vollständiges Handbuch mit nahezu finalen Inhalten und intakten/funktionierenden Elementen wie Querverweisen geben.
Woche 13: 2. Pass bearbeiten/Korrekturlesen, Typsatz/Layout prüfen, Senden
In der 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.