Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- LLVM-Compilerinfrastruktur
- Technischer Redakteur:
- DR87
- Projektname:
- LLVM-Dokumentationsindex und -Styleguide neu strukturieren
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
Dieses Projekt umfasst die folgenden Aufgaben:
a.) Die Indexseite der Dokumentation wurde neu strukturiert, um die Nutzerfreundlichkeit zu verbessern. Dabei wird die aktuelle Seite anhand einer Kombination aus unabhängiger Forschung, Interviews mit Fachleuten und Nutzerfeedback bewertet und neu strukturiert. Mögliche Optionen sind die Überarbeitung der Kurzbeschreibungen, die Neustrukturierung der bestehenden Seite und/oder das Hinzufügen zusätzlicher Ebenen (Seiten) mithilfe eines Progressive-Informations-Offenlegungsmodells. Letzteres würde die Anzahl der Links auf der Hauptindexseite reduzieren, damit Nutzer bestimmte Informationen/Anleitungen leichter finden können. Der Index kann beispielsweise Links zu separaten Seiten für LLVM-Design und -Übersicht, Nutzerhandbücher, Subsystem-Dokumentation und Dokumentation des Entwicklungsprozesses enthalten.
b.) Aktualisierung des LLVM-Sphinx-Styleguides für Open-Source-Mitarbeiter. Dazu gehört die Bewertung des aktuellen Leitfadens, die Identifizierung von Lücken durch unabhängige Forschung und Interviews mit SME sowie die Aktualisierung des Leitfadens auf der Grundlage der vereinbarten Anforderungen. Aktualisierungen können das Neuorganisieren des Layouts des Leitfadens, das Hinzufügen neuer Inhalte und das Einfügen von Links zu relevanten Seiten wie dem Leitfaden für Mitwirkende umfassen. Ziel ist es, es Freiwilligen so einfach wie möglich zu machen, schnell mit dem Beitragen zu beginnen.