Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- moja global
- Technischer Redakteur:
- Anthony
- Projektname:
- Dokumentation zum Reporting-Tool-Code
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
Da ich die Möglichkeit habe, das Reporting-Tool für die Organisation Moja Global zu dokumentieren, schlage ich vor, sechs Arten von Dokumentation zu entwickeln, die von verschiedenen Zielgruppen für unterschiedliche Zwecke verwendet werden. Diese werden unten zusammengefasst:
1) Leitfaden zur Umgebungskonfiguration
1.1) Zielgruppe: Systemingenieure
1.2) Objective Help System Engineers bei der Einrichtung einer lokalen Build- und Ausführungsumgebung für das Reporting-Tool
1.3) Format Ein Anleitungsartikel, der eine Reihe von Schritten vorschreibt, die Systementwickler zur Einrichtung der Umgebung unternehmen müssen, die für die Erstellung und Ausführung des Reporting-Tools geeignet ist.
2) Anleitung zum Erstellen
2.1) Zielgruppe Systemingenieure
2.2) Ziel Systemingenieuren helfen, die Komponenten des Berichtstools aus dem Quellcode zu erstellen
2.3) Format: Ein Anleitungsartikel, der die Abfolge der Schritte beschreibt, die Systemingenieure ausführen müssen, um den Quellcode des Berichtstools zu erhalten und zu kompilieren.
3) Installationsanleitung
3.1) Zielgruppe: Systemingenieure
3.2) Ziel: Systemingenieuren bei der Installation frisch erstellter Komponenten des Berichtstools helfen
3.3) Formatieren Ein Anleitungsartikel, der die aufeinanderfolgenden Schritte vorschreibt, die Systementwickler ausführen müssen, um das Reporting-Tool in einer neu eingerichteten Umgebung bereitzustellen.
4) Betriebsanleitung
4.1) Systemintegratoren von Zielgruppen
4.2) Ziel: Systemingenieuren helfen, eine frisch installierte Instanz des Berichtstools auszuführen
4.3) Format: Ein Anleitungsartikel, der die einzelnen Schritte beschreibt, die Systemintegratoren ausführen müssen, um Flux-Ausgabedatenbanken in einer laufenden Reporting Tool-Instanz hochzuladen und zu verarbeiten.
Bedienungsanleitung: Flux-Ausgabedatenbanken im Berichtstool einrichten und verarbeiten
5) Nutzerhandbuch
5.1) Zielgruppe Endnutzer
5.2) Ziel: Hilfe für Endnutzer, die verschiedenen Funktionen des Berichtstools zu verstehen und zu erfahren, wie diese Funktionen verwendet werden sollten.
5.3) Format: Ein Anleitungsartikel, der die Abfolge der Schritte beschreibt, die Endnutzer ausführen müssen, um die Funktionen des Berichtstools richtig zu nutzen.
6) Entwicklungsleitfaden
6.1) Zielgruppe: Programmierer
6.2) Ziel: Hilfe für Endnutzer, die verschiedenen Funktionen des Berichtstools zu verstehen und zu erfahren, wie diese Funktionen verwendet werden sollten.
6.3) Formatieren Referenzartikel, die Folgendes beschreiben: a) die wichtigsten Designelemente, aus denen das Tool besteht b) die funktionale Zerlegung der obigen Elemente c) die Ausführungselemente der funktional aufgeteilten Elemente d) den Quellcode / die Organisation der Bibliotheken des Tools e) die langfristige Vision und Richtung für kontinuierliche Verbesserung f) die logischen nächsten Verbesserungsbereiche
und eine kurze Anleitung, wie der Code an nutzerspezifische Gegebenheiten angepasst werden kann