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:
- Django
- Technischer Redakteur:
- Gabbyprecious
- Projektname:
- Leitfaden für Beiträge umformulieren, sodass sie nutzerfreundlicher und nutzerfreundlicher sind
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Abstrakt
Wie jede andere Dokumentation ist das Ziel des Handbuchs für Beiträge von Django, Nutzern und Open-Source-Mitwirkenden in diesem Fall eine Anleitung zu bieten, wie und wo sie dazu beitragen können, Django besser und nachhaltiger zu gestalten.
Es besteht immer die Notwendigkeit, Dokumentationen zu erstellen, insbesondere eine, die große Auswirkungen auf die Community und Django selbst hat.
Das Ziel von Django für den diesjährigen Google Summer of Docs ist es, den Leitfaden zu Beiträgen weniger überwältigend, zugänglich und einladend für Beitragende zu gestalten. Das ist ein wichtiges Ziel, das Beitragende ermutigt, zu denen ich selbst gehöre, wenn es darum geht, einen Beitrag zu diesem großartigen Rahmenwerk zu leisten.
Aktueller Status
Die aktuelle Phase der Dokumentation, die Sie hier finden, ist nicht wirklich eine Anleitung, da sie zu überwältigend und nicht gut strukturiert ist und dazu führt, dass die Beiträge in Django weniger gut verstanden werden und neue Beitragende nicht willkommen sind.
Projektziele
Ich habe meine Vorschläge für die Dokumentation mit meinem Mentor, Carlton Gibson, im Forum besprochen, und er ist überzeugt, dass dies bei dem großen Problem mit der aktuellen Dokumentation helfen würde. Folgende Ziele werde ich bei der Umstrukturierung des Dokuments erreichen: Das Dokument neu strukturieren Tipps für einzelne Abschnitte hinzufügen Einzelne Seiten für einfache Abschnitte wie das Anfordern und Erstellen von Funktionen erstellen Reduzierte und direkt relevante Dokumentation Glossar für Wörter Interner Index, der dem neuen Leitfaden orientiert ist Eine ansprechendere Dokumentation schreiben Inhalte in zwei Hauptbereiche aufteilen: für Einsteiger und Beitragende und für Fortgeschrittene.
Die aktuelle Dokumentation richtet sich bereits an fortgeschrittene Beitragende und bietet weder Neueinsteigern noch Anfängern die Möglichkeit, sowohl Open-Source- als auch Django-Einsteiger zu sein. Hier sind einige zusätzliche Inhalte für Einsteiger: Abschnitt mit verschiedenen Gruppen von Mitwirkenden(technische Autoren, Designer und Entwickler) Auf dieser Seite werden die Probleme, die zum ersten Mal auftreten, und einfache Probleme, die gelöst werden können, dokumentiert. Nehmen Sie einige Abschnitte in der aktuellen Dokumentation, schreiben Sie sie um und ergänzen Sie sie im Abschnitt für Anfänger. Abschnitte, in denen die wichtigsten Punkte oder Wörter erklärt werden, die im erweiterten Abschnitt verwendet werden.
Zeitplan
Nachfolgend finden Sie eine Aufschlüsselung dazu, wie ich mithilfe des von Google bereitgestellten Kalenders an dem oben genannten Projektziel arbeiten möchte.
Community-Bonding-Woche( 17. August bis 13. September) Zusätzliche Interaktion mit der Community nutzen Weitere Beiträge zur Dokumentation beitragen Mehr Vorschläge von Contributors erhalten Weitere Informationen zur aktuellen Dokumentation und geplanten Tools Woche 1 bis Woche 4 Beginnen Sie mit der Abschnittsdokumentation basierend auf den Levels Erstellen Sie den Abschnitt für Einsteiger der Dokumentation Aktuellen Leitfaden zum Indexieren und 6 Neue Abschnitte zu Dos und Don’ts für Veröffentlichungen überarbeiten Woche 4 – 6 Neue Abschnitte zu Dos und Don't-Texten für die Veröffentlichung in der Dokumentation erstellen
Tools
Sphinx – aktuelles Tool für die aktuelle Dokumentation. Lesen Sie die Dokumente.
Warum dieses Projekt?
Ich bin von Grund auf gut geschriebene Dokumentationen und Artikel, die jeden in der Welt abdecken. Abgesehen davon bin ich auch ein Fan von Django und Open Source als Ganzes. Ich wollte schon als Anfänger zu Django beitragen, und ich denke, dass dies eine perfekte Möglichkeit ist, um zu meinem Lieblingstool beizutragen. Gleichzeitig sollte ich mich mit der Codebasis vertraut machen, um als Entwickler(und technischer Redakteur) mehr Beiträge zu leisten. Ich freue mich, mit einem Unternehmen zusammenzuarbeiten, das meinen Ansichten entspricht und meine gesamte Karriere vorangebracht hat.
Warum bin ich die richtige Person für dieses Projekt?
Ich bin in Anbetracht der folgenden Konten die richtige Person: Ich habe einen Beitrag zu Django geleistet und Artikel verfasst, die Anfängern helfen, das Konzept von Django besser zu verstehen. Ich bin Entwickler und freue mich darauf, einen Beitrag zu Django zu leisten. Mir ist bewusst, wie wichtig andere Entwickler sind und wie ich dies für sie gut dokumentieren kann. Ich bin ein Teamplayer und arbeite gut unter der Leitung meines Mentors Carlton Gibson.