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:
- Moja weltweit
- Technischer Redakteur:
- Anthony
- Projektname:
- Dokumentation zum Code des Reporting-Tools
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Aufgrund der Möglichkeit, das Reporting-Tool für die Organisation Moja Global zu dokumentieren, schlage ich vor, sechs Arten von Dokumentationen zu entwickeln, die von verschiedenen Zielgruppen für unterschiedliche Zwecke verwendet werden. Hier eine Zusammenfassung:
1) Leitfaden zur Einrichtung der Umgebung
1.1) Audience System Engineers
1.2) Ziel Unterstützung von Systementwicklern beim Einrichten einer lokalen Build- und Ausführungsumgebung für das Reporting-Tool.
1.3) Formatieren Sie einen Anleitungsartikel, der die aufeinanderfolgenden Schritte vorgibt, die Systemtechniker unternehmen müssen, um eine Umgebung einzurichten, die für die Entwicklung und Ausführung des Reporting-Tools förderlich ist.
2) Erstellungsanleitung
2.1) Audience System Engineers
2.2) Ziel Unterstützung von Systemtechnikern beim Aufbau der Reporting-Tool-Komponenten aus dem Quellcode
2.3) Format eines Anleitungsartikels, der die aufeinanderfolgenden Schritte vorgibt, die Systementwickler ausführen müssen, um den Quellcode des Reporting-Tools zu erhalten und zu kompilieren.
3) Installationsanleitung
3.1 Zielgruppe: Systemtechniker
3.2) Ziel Unterstützung von Systemtechnikern bei der Installation neu erstellter Reporting-Tool-Komponenten
3.3) Formatieren Sie einen Anleitungsartikel, der die aufeinanderfolgenden Schritte vorgibt, die Systementwickler ausführen müssen, um das Reporting-Tool in einer neu eingerichteten Umgebung bereitzustellen.
4) Bedienungsanleitung
4.1 Zielgruppe Systemintegratoren
4.2) Ziel Unterstützung von Systemtechnikern bei der Ausführung einer neu installierten Reporting-Tool-Instanz
4.3) Formatieren Sie einen Anleitungsartikel, der die aufeinanderfolgenden Schritte vorgibt, die Systemintegratoren zum Hochladen und Verarbeiten von Flux-Ausgabedatenbanken auf einer laufenden Reporting-Tool-Instanz ausführen müssen.
Bedienungsanleitung Flux-Ausgabedatenbanken im Reporting-Tool einrichten und verarbeiten
5) Nutzerhandbuch
5.1 Zielgruppe Endnutzer
5.2) Ziel Helfen Sie Endnutzern, die verschiedenen im Reporting-Tool integrierten Funktionen zu verstehen und zu verstehen, wie diese Funktionen verwendet werden sollten.
5.3) Formatierung eines Anleitungsartikels, der die aufeinanderfolgenden Schritte vorschreibt, die die Endnutzer zur ordnungsgemäßen Verwendung der Funktionen des Reporting-Tools ausführen müssen.
6) Entwicklungsleitfaden
6.1) Programmierer von Zielgruppen
6.2) Ziel Helfen Sie Endnutzern, die verschiedenen im Reporting-Tool integrierten Funktionen zu verstehen und zu verstehen, wie diese Funktionen verwendet werden sollten.
6.3) Format von Referenzartikeln, die Folgendes beschreiben: a) die wichtigsten Designelemente, aus denen das Tool besteht b) die funktionale Zerlegung der oben genannten Elemente c) die Ausführungselemente der funktional zerlegten Elemente d) die Organisation des Quellcodes bzw. der Bibliotheken des Tools e) die langfristige Vision und Richtung für kontinuierliche Verbesserung f) die logischen nächsten Bereiche für Verbesserungen
Und eine kurze Anleitung, in der beschrieben wird, wie der Code an die spezifischen Umstände der Nutzenden angepasst werden kann.