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:
- LLVM-Compiler-Infrastruktur
- Technischer Redakteur:
- DR87
- Projektname:
- LLVM-Dokumentationsindex und -Dokumentation neu strukturieren
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Dieses Projekt umfasst die folgenden Aufgaben:
a.) Sie strukturieren die Dokumentationsindexseite neu, um sie nutzerfreundlicher zu gestalten. Diese Aufgabe umfasst die Bewertung der aktuellen Seite und die Neustrukturierung auf der Grundlage einer Kombination aus unabhängiger Forschung, Interviews mit Fachleuten und Feedback von Nutzenden. Mögliche Optionen sind die Überarbeitung der Kurzbeschreibungen, die Neustrukturierung der vorhandenen Seite und/oder das Hinzufügen zusätzlicher Ebenen (Seiten) über ein progressives Modell zur Offenlegung von Informationen. Letzteres würde die Anzahl der Links auf der Hauptindexseite verringern, damit Nutzer bestimmte Informationen/Handbücher leichter finden können. Der Index kann beispielsweise Links zu separaten Seiten für LLVM Design & Übersicht, Benutzerhandbücher, Subsystem-Dokumentation und Dokumentation zum Entwicklungsprozess enthalten.
b.) Aktualisieren Sie den LLVM Sphinx-Styleguide für Open-Source-Mitwirkende. Diese Aufgabe umfasst die Bewertung des aktuellen Leitfadens, das Identifizieren von Lücken durch unabhängige Forschung und Interviews mit KMUs und die Aktualisierung des Leitfadens basierend auf den vereinbarten Anforderungen. Dabei kann es sich zum Beispiel um eine Neustrukturierung des Leitfadens, das Hinzufügen neuer Inhalte und das Einfügen von Links zu relevanten Seiten wie dem Leitfaden für Beitragende handeln. Ziel ist es, Freiwilligen die Erstellung von Beiträgen so bald wie möglich zu erleichtern.