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:
- Moja weltweit
- Technischer Redakteur:
- Anthony
- Projektname:
- Code-Dokumentation für das Reporting-Tool
- 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 unterschiedlichen Zielgruppen für unterschiedliche Zwecke verwendet werden können. Das sind die Ergebnisse:
1) Einrichtungsleitfaden für die 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, in dem die aufeinanderfolgenden Schritte beschrieben werden, die Systementwickler zum Einrichten einer Umgebung unternehmen müssen, die für die Erstellung und Ausführung des Reporting-Tools geeignet ist.
2) Erstellungsanleitung
2.1) Systemtechniker für die Zielgruppe
2.2) Zielsetzung Unterstützung von Systementwicklern beim Erstellen der Reporting-Tool-Komponenten aus dem Quellcode
2.3) Formatieren Sie einen Anleitungsartikel, in dem die aufeinanderfolgenden Schritte beschrieben werden, die Systementwickler zum Abrufen und Kompilieren des Quellcodes des Reporting-Tools ausführen müssen.
3) Installationsanleitung
3.1) Zielgruppe Systemtechniker
3.2) Ziel Unterstützung von Systemtechnikern bei der Installation neu erstellter Komponenten des Reporting-Tools
3.3) Formatieren Sie einen Anleitungsartikel, in dem die aufeinanderfolgenden Schritte beschrieben werden, die Systementwickler zur Bereitstellung des Reporting-Tools in einer neu eingerichteten Umgebung ausführen müssen.
4) Bedienungsanleitung
4.1) Zielgruppe Systemintegratoren
4.2) Ziel Unterstützung von Systemtechnikern beim Ausführen einer neu installierten Instanz für das Reporting-Tool
4.3) Formatieren Sie einen Anleitungsartikel, in dem die aufeinanderfolgenden Schritte beschrieben sind, die Systemintegratoren zum Hochladen und Verarbeiten von Flux-Ausgabedatenbanken auf einer laufenden Reporting-Tool-Instanz ausführen müssen.
Bedienungsanleitung Onboarding und Verarbeitung von Flux-Ausgabedatenbanken im Reporting-Tool
5) Nutzerhandbuch
5.1) Zielgruppe Endnutzer
5.2) Ziel Helfen Sie Endnutzern, die verschiedenen Funktionen des Reporting-Tools zu verstehen und zu verstehen, wie diese Funktionen verwendet werden sollten.
5.3) Format eines Anleitungsartikels, in dem die aufeinanderfolgenden Schritte beschrieben werden, die die Endnutzer unternehmen müssen, um die Funktionen des Reporting-Tools ordnungsgemäß nutzen zu können.
6) Entwicklungsleitfaden
6.1) Zielgruppenprogrammierer
6.2) Ziel Helfen Sie Endnutzern, die verschiedenen Funktionen des Reporting-Tools zu verstehen und zu verstehen, wie diese Funktionen verwendet werden sollten.
6.3) Referenzartikel formatieren, in denen Folgendes beschrieben wird: 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 / der Bibliotheken e) die langfristige Vision und die Richtung der kontinuierlichen Verbesserung f) die logischen nächsten Verbesserungsbereiche
Und ein kurzes Tutorial, in dem beschrieben wird, wie der Code an die speziellen Umstände der Nutzenden angepasst werden kann.