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:
- LLVM-Compiler-Infrastruktur
- Technischer Redakteur:
- DR87
- Projektname:
- LLVM-Dokumentationsindex und -Dokumentations-Styleguide neu strukturieren
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Dieses Projekt umfasst die folgenden Aufgaben:
a.) Strukturieren Sie die Dokumentationsindexseite um, um sie nutzerfreundlicher zu gestalten. Diese Aufgabe umfasst die Bewertung der aktuellen Seite und die Neustrukturierung basierend auf einer Kombination aus unabhängigen Studien, Interviews mit KMU und Feedback von Nutzenden. Sie haben beispielsweise die Möglichkeit, die Kurzbeschreibungen zu überarbeiten, die vorhandene Seite neu zu strukturieren und/oder zusätzliche Ebenen (Seiten) über ein progressives Modell zur Offenlegung von Informationen hinzuzufügen. Letzteres würde die Anzahl der Links auf der Hauptindexseite reduzieren, damit Nutzer bestimmte Informationen/Reiseführer leichter finden können. Der Index kann beispielsweise Links zu separaten Seiten für LLVM Design & Übersicht, Nutzerhandbü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 Befragungen von KMU sowie die Aktualisierung des Leitfadens auf der Grundlage der vereinbarten Anforderungen. Aktualisierungen könnten beispielsweise eine Neustrukturierung des Leitfadens, das Hinzufügen neuer Inhalte und das Einfügen von Links zu relevanten Seiten wie dem Leitfaden für Beitragende beinhalten. Ziel ist es, es Freiwilligen zu erleichtern, so schnell wie möglich einen Beitrag zu leisten.