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:
- Django
- Technischer Redakteur:
- Gabbyprecious
- Projektname:
- Leitfaden für Beiträge umformulieren, damit er nutzerfreundlicher und leichter zu bedienen ist
- Projektdauer:
- Standardlaufzeit (3 Monate)
Projektbeschreibung
ABSTRACT
Das Ziel des Django-Beitragsleitfadens besteht wie bei jeder anderen Dokumentation darin, Nutzern, in diesem Fall Open-Source-Entwicklern, zu zeigen, wie und wo sie dazu beitragen können, Django besser und nachhaltiger zu machen.
Es ist immer notwendig, Dokumentationen zu erstellen, insbesondere solche, die sich stark auf die Community und Django selbst auswirken.
Das Ziel von Django für das diesjährige Google Summer of Docs-Programm ist es, den Leitfaden für Beiträge übersichtlicher, zugänglicher und einladender für Mitwirkende zu gestalten. Dies ist ein wichtiges Ziel, das entscheidend dazu beiträgt, Beitragende zu unterstützen, zu denen ich selbst gehöre.
Aktueller Status
Die aktuelle Version der hier verfügbaren Dokumentation ist nicht wirklich ein Leitfaden, da sie zu überwältigend und nicht gut strukturiert ist. Sie führt zu einem geringeren Verständnis von Beiträgen in Django und ist für neue Mitwirkende nicht einladend.
Projektziele
Ich habe meine Vorschläge für die Dokumentation mit meinem Mentor Carlton Gibson im Forum besprochen und er stimmt zu, dass sie das überwältigende Problem mit der aktuellen Dokumentation beheben werden. Hier sind die Ziele, die ich mit der Umstrukturierung des Dokuments erreichen möchte: Dokument umstrukturieren Tipps und Hinweise für die einzelnen Abschnitte hinzufügen Einzelne Seiten für einfache Abschnitte wie „Funktionen anfordern und erstellen“ erstellen Eingeschränkte und auf den Punkt gebrachte Dokumentation Glossar für Begriffe Interner Index, der dem neuen Leitfaden folgt Eine verständlichere Dokumentation verfassen Inhalte in zwei Hauptteile segmentieren (Abschnitte für Anfänger und fortgeschrittene Mitwirkende) Leitfaden und Stil für neue technische Autoren/Mitwirkende erstellen, um die Dokumente auf dem neuesten Stand zu halten und Standards einzuhalten.
Die aktuelle Dokumentation richtet sich bereits an fortgeschrittene Beitragende und bietet weder neuen noch Anfängern die Chance, sowohl zu Open Source als auch zu Django zu werden. Im Folgenden finden Sie einige zusätzliche Inhalte für Anfänger: Abschnitt mit Anleitungen für verschiedene Mitwirkende(technische Autoren, Designer und Entwickler) Eine Seite, auf der erste Probleme mit Timern und einfache zu lösende Probleme dokumentiert sind. Nehmen Sie einige Abschnitte aus der aktuellen Dokumentation, überarbeiten Sie sie und fügen Sie sie dem Abschnitt für Anfänger hinzu. Abschnitte, in denen wichtige Punkte oder Begriffe aus dem erweiterten Abschnitt erklärt werden.
Zeitachse
Im Folgenden finden Sie eine Aufschlüsselung, wie ich das oben aufgeführte Projektziel mit dem von Google bereitgestellten Kalender angehen möchte.
Woche der Community-Bindung( 17. August bis 13. September) Mehr Engagement mit der Community Weiter an der Dokumentation arbeiten Weitere Vorschläge von Mitwirkenden einholen Weitere Studien der aktuellen Dokumentation und der vorgesehenen Tools Woche 1 bis Woche 4 Beginnen, die Dokumentation nach Stufen zu unterteilen Abschnitt für Anfänger in der Dokumentation erstellen Woche 4 bis Woche 6 Dos und Don’ts zusammenstellen Abschnittsspezifische Dos und Don’ts aufschreiben Zusätzliche Seiten für Abschnitte Woche 7 bis Woche 9 Aktuelle Dokumentation umschreiben und in den Leitfaden für fortgeschrittene Mitwirkende verschieben Dokumentation reduzieren Woche 10 bis Woche 12 Glossar vorbereiten Internen Index an die neue Dokumentation anpassen Leitfaden und Stil für neue technische Redakteure/Mitwirkende erstellen
Tools
Sphinx - aktuelles Tool für die aktuelle Dokumentation. Lesen Sie die Dokumentation.
Warum dieses Projekt?
Ich bin davon überzeugt, dass gut geschriebene Dokumentationen und Artikel für alle Menschen auf der Welt geeignet sein sollten. Außerdem bin ich ein Fan von Django und Open Source im Allgemeinen. Ich wollte schon länger als Anfänger zu Django beitragen und denke, dass dies eine perfekte Möglichkeit ist, zu meinem Lieblingstool beizutragen und mich gleichzeitig mit der Codebasis vertraut zu machen, um als Entwickler(und technischer Redakteur) mehr beizutragen. Es wird angenehm und schön sein, mit einer Organisation zusammenzuarbeiten, die meinen Ansichten entspricht und in meiner gesamten Karriere ein großartiges Werkzeug war.
Warum bin ich die richtige Person für dieses Projekt?
Ich glaube, dass ich aufgrund der folgenden Gründe die richtige Person bin: Ich habe Beiträge zu Django geleistet, indem ich Artikel geschrieben habe, die Anfängern das Konzept von Django näherbringen. Als Entwickler, der sich darauf freut, zu Django beizutragen, verstehe ich die Anforderungen anderer Entwickler und wie man sie gut für sie dokumentiert. Ich bin ein Teamplayer und kann gut mit mehr oder weniger Anleitung durch meinen Mentor Carlton Gibson arbeiten.