Aktuelle Phase:
Die Saison 2019 für Google Docs wurde am 6. März 2020 beendet. Siehe Zeitachse.
Diese Seite enthält eine Übersicht für technische Redakteure, die an „Season of Docs“ mitwirken.
Einführung
Willkommen bei Season of Docs! In diesem Leitfaden erfahren Sie etwas über Ihre Teilnahme am Programm "Season of Docs" und finden Tipps zu den Aktivitäten, die Sie in jeder Phase des Programms durchführen sollten.
Voraussetzungen für die Teilnahme an der Staffel von Google Docs
Um als technischer Redakteur an der Staffel von Google Docs teilnehmen zu können, müssen folgende Voraussetzungen erfüllt sein:
- Zum Zeitpunkt der Registrierung mindestens 18 Jahre alt.
- Sie müssen über Kenntnisse im technischen Schreiben verfügen, indem sie Rollenbeschreibungen und Arbeitsproben einreichen.
- Sie können während der Dauer des Programms in dem Land Ihres Wohnsitzes arbeiten.
- Bewohner eines Landes, dem die USA derzeit kein Embargo unterliegen. Weitere Informationen finden Sie in den Sanktionsprogrammen und Länderinformationen des US-Finanzministeriums.
Die vollständigen Nutzungsbedingungen für technische Redakteure finden Sie hier.
Ihre Open-Source-Mentoren
Mentoren aus Google Docs sind nicht unbedingt technische Redakteure und haben möglicherweise wenig Erfahrung in der technischen Kommunikation. Sie sind Mitglieder der Open-Source-Organisation, die den Wert einer guten Dokumentation kennen und Erfahrung mit Open-Source-Prozessen und -Tools haben.
Die Beziehung zwischen dir und deinen Mentoren ist eine Zusammenarbeit. Sie bringen Erfahrung und Fähigkeiten in der Dokumentation in die Open-Source-Organisation ein. Die beratenden Personen bringen ihr Wissen über Open Source und Code mit. Gemeinsam können Sie die technische Dokumentation entwickeln und die Prozesse des Open-Source-Projekts verbessern.
Programmankündigung und Bewerbungsphasen der Organisation
Das Ankündigungsdatum für die Staffel von Google Docs ist der 11. März 2019. Interessierte Open-Source-Organisationen können sich zwischen dem 2. April 2019 und dem 23. April 2019 für die Teilnahme an der „Season of Docs“ bewerben. Die Google-Programmadministratoren veröffentlichen die Liste der erfolgreichen Organisationen am 30. April 2019.
Achten Sie in der Zeit zwischen der Programmankündigung und der Veröffentlichung der teilnehmenden Open-Source-Organisationen regelmäßig auf aktuelle Nachrichten. Sie können zu dieser Website zurückkehren und nach Blogposts oder anderen Nachrichten im Web Ausschau halten. Einige der Open-Source-Organisationen teilen ihre Ideen möglicherweise auch während der Bewerbungsphase der Organisation.
Wir laden Sie auch ein, uns mitzuteilen, warum Sie an dem Programm interessiert sind. Sieh dir das Werbematerial für Grafiken und Ideen an.
Phase der Erkundung des technischen Redakteurs
Die explorative Datenanalyse des technischen Redakteurs dauert vom 30. April bis zum 28. Mai 2019. In dieser Zeit können Sie sich die Liste der teilnehmenden Organisationen und deren Projektideen ansehen.
Wenn Sie ein oder mehrere Projekte finden, die Sie interessieren, sollten Sie sich direkt an die entsprechende Open-Source-Organisation wenden, um die Projektideen zu besprechen.
| Ihre Aufgaben als technischer Redakteur in dieser Phase | |
|---|---|
|
Sehen Sie sich die Liste der teilnehmenden Open-Source-Organisationen und ihre Projektideen an. |
Suchen Sie in der Liste nach einer Open-Source-Organisation, mit der Sie zusammenarbeiten möchten. Sehen Sie sich die von den Organisationen vorgeschlagenen Projekte für das technische Schreiben an und entscheiden Sie, welche für Sie geeignet sind. Sie können sich auch bei mehreren Organisationen bewerben. In dieser Phase von „Season of Docs“ sollten Sie mehr als eine Option ausprobieren. Im endgültigen Auswahlprozess kann jeder technische Redakteur nur ein Projekt auswählen. |
|
Projektideen mit Open-Source-Organisationen besprechen |
Sie können Projektideen mit einer der teilnehmenden Organisationen besprechen. Verwenden Sie als Kontakt die E-Mail-Adresse der Organisation, die in der Liste der teilnehmenden Organisationen angezeigt wird. Frühzeitige Diskussionen helfen Ihnen, einen guten Projektvorschlag zu erstellen, den Sie während der Bewerbungsphase als technische Redakteur den Google-Programmadministratoren zur Verfügung stellen können. Die ersten Projektideen können aus der Ideenliste stammen, die die Organisation vorgeschlagen hat. Sie können auch eigene Ideen einbringen. |
Bewerbungsphase des technischen Redakteurs
Die Bewerbungsphase für technische Redakteure dauert vom 29. Mai 2019 bis zum 28. Juni 2019. In dieser Zeit können Sie sich für die Teilnahme an der Staffel von Google Docs bewerben. Die Google-Programmadministratoren leiten die relevanten Details aus Ihrer Anwendung an die von Ihnen ausgewählte Open-Source-Organisation weiter. Die Open-Source-Organisationsadministratoren und -Mentoren wählen dann die Projekte aus, die als Mentor fungieren sollen.
| Ihre Aufgaben als Bewerber beim technischen Redakteur in dieser Phase | |
|---|---|
|
Reichen Sie Ihre Bewerbung für die Teilnahme an „Season of Docs“ ein. |
Reichen Sie Ihre Bewerbung für die Staffel von Google Docs bis zum 28. Juni 2019 ein. Für die Saison 2019 in Google Docs ist keine Bewerbung für technische Redakteure mehr möglich. |
Phase der Beziehung zur Community
Die Phase der Community-Kundschaft dauert vom 7. August bis 1. September 2019. In dieser Zeit helfen Ihnen die Open-Source-Mentoren, sich mit dem Open-Source-Projekt und der Community vertraut zu machen.
| Ihre Aufgaben als technischer Redakteur in dieser Phase | |
|---|---|
|
Kommunikationskanäle einrichten. |
Nehmen Sie Kontakt zu Ihrem/Ihren Mentor(en) in der Open-Source-Organisation auf, mit der Sie zusammenarbeiten möchten. Sie müssen zuverlässig direkt mit Ihrem Mentor und den Organisationsadministratoren kommunizieren können. Letztere sind die Mitglieder der Open-Source-Organisation, die als Hauptkontakt für Season of Docs für ihre Organisation fungieren. Die Verantwortlichkeiten Ihrer Mentoren Leitfaden für Mentoren für die Zusammenarbeit mit technischen Redakteuren |
|
Beteiligen Sie sich am Open-Source-Projekt und der Community. |
Stellen Sie Ihrer beratenden Person Fragen zu den Tools und Prozessen, die die Open-Source-Organisation verwendet. Stellen Sie sich mit den Mailinglisten, dem Chat, dem Slack-Kanal und allen anderen gemeinsamen Kommunikationskanälen der Open-Source-Community vor. |
|
Sie lernen das Produkt als Ganzes kennen. |
Bitten Sie Ihre beratende Person, das Produkt (insbesondere konzeptionell) zu erklären, das Sie bald dokumentieren werden. Besprechen Sie die Zielgruppe der Dokumentation im Detail. |
|
Ziele und Erwartungen festlegen |
Verfeinern Sie gemeinsam mit Ihrer beratenden Person die Ziele Ihres Projekts für das technische Schreiben und legen Sie Erwartungen auf beiden Seiten fest. Wenn Sie diese Ziele und Erwartungen jetzt festlegen, können Sie den Erfolg Ihres Projekts sicherstellen. |
Entwicklungsphase des Dokuments
Die Phase der Dokumententwicklung dauert vom 2. September 2019 bis zum 22. November 2019. Bei Projekten mit langer Laufzeit gilt ein anderes Enddatum. Während dieser Zeit arbeiten Sie unter enger Absprache mit Ihren beratenden Personen an Ihrem Projekt.
| Ihre Aufgaben als technischer Redakteur in dieser Phase | |
|---|---|
|
Arbeiten Sie mit Ihrer beratenden Person zusammen, um Ihr Projekt abzuschließen. |
Arbeiten Sie eng mit Ihrer beratenden Person zusammen, um Ihr Projekt abzuschließen. Folgen Sie den Verfahren der Open-Source-Community, um Überprüfungen der resultierenden Dokumentation anzufordern und die Aktualisierungen an das Open-Source-Repository zu senden. Open-Source-Projekte, die auf GitHub gehostet werden, können beispielsweise Dateien hinzufügen oder aktualisieren. Erstellen Sie dazu eine Pull-Anfrage zum Prüfen und Senden. |
|
Wenden Sie sich mit Bedenken an den Administrator der Organisation. |
Wenn Sie Bedenken bezüglich der Kommunikation mit Ihren Mentoren haben oder andere Probleme haben, die sich auf den erfolgreichen Abschluss Ihres Projekts auswirken könnten, informieren Sie den Administrator der Open-Source-Organisation. |
|
Nehmen Sie an einer beliebigen Umfrage der Google-Programmadministratoren teil. |
Die Programmadministratoren von Google können mitten im Projekt eine Umfrage versenden, um den Fortschritt zu bewerten. Nimm an der Umfrage teil und sende deine Antworten gemäß den Anweisungen im Umfragedokument an die Google-Programmadministratoren. |
Projektabschluss- und Bewertungsphase
Die Projektabschlussphase dauert vom 25. bis 29. November 2019, die Bewertungsphase dauert vom 25. November bis 6. Dezember 2019. Bei Projekten mit langer Laufzeit unterscheiden sich die Datumsangaben. Während der Projektabschlussphase reichen Sie Ihren Projektbericht ein, der auch als Ihre finalen Arbeitsprodukte bezeichnet wird. Während der Bewertungsphase reichen Sie die Bewertung Ihrer Mentoren und Ihre Erfahrungen als Teilnehmer an „Season of Docs“ ein.
| Ihre Aufgaben als technischer Redakteur in dieser Phase | |
|---|---|
|
Erstellen Sie Ihren Projektbericht. |
Sie schreiben Ihren Projektbericht (manchmal als Arbeitsprodukt bezeichnet). Der Projektbericht enthält eine Beschreibung der Arbeit, die Sie während der Dokumentsaison geleistet haben, und alle relevanten Links. die Projektabschlussphase für die Saison 2019 von Google Docs ist beendet. |
|
Bitten Sie Ihre beratende Person, sich Ihren Projektbericht anzusehen. |
Ihre beratende Person kann wertvolle Erkenntnisse darüber haben, wie Sie Ihre Erfolge beschreiben sollen. In dieser Phase ist es außerdem hilfreich, ein gemeinsames Verständnis des Projektstatus zu erlangen, bevor die beratende Person das Projekt als erfolgreich abgeschlossen oder nicht markiert. |
|
Den Projektbericht fertigstellen |
Die Fertigstellung deines Projektberichts ist der 28. Februar 2020 um 18:00 Uhr (UTC). Das Formular kann bearbeitet werden, aber Sie müssen die endgültige Version bis zum angegebenen Datum einreichen. die Projektabschlussphase für die Saison 2019 von Google Docs ist beendet. |
|
Schreiben Sie Ihre Bewertung Ihres Mentors und Ihre Erfahrungen mit Season of Docs. |
Sie müssen Ihre Bewertung bis zum 28. Februar 2020 um 18:00 Uhr (UTC) abschließen und einreichen. Bewertungen durch technische Redakteure die Projektabschlussphase für die Saison 2019 von Google Docs ist beendet. |
Lang andauernde Projekte
Bei Projekten zum technischen Schreiben in Standardlänge in „Season of Docs“ dauert die Dokumententwicklungsphase vom 2. September 2019 bis zum 22. November 2019. Einige technische Redakteure beantragen jedoch möglicherweise ein lang andauerndes Projekt in Absprache mit der Open-Source-Organisation. Bei einem lang andauernden Projekt dauert die Dokumententwicklungsphase vom 2. September 2019 bis zum 21. Februar 2020.
Der Projektabschluss- und -bewertungszeitraum für lang andauernde Projekte dauert vom 24. bis 28. Februar 2020.
Ihre Aufgaben und Verantwortlichkeiten sind die gleichen wie auf dieser Seite für technische Schreibprojekte in Standardlänge beschrieben, mit der Ausnahme, dass die Termine für Projektabschluss und Bewertungen später liegen.
Weitere Informationen
- Sehen Sie sich die Zeitachse für die Saison von Google Docs an.
- Weitere Informationen zu Ihrer Beziehung zu der von Ihnen ausgewählten Open-Source-Organisation finden Sie in den Verantwortlichkeiten für Organisationsadministratoren und Mentoren und in den Richtlinien für Mentoren zur Arbeit mit technischen Redakteuren.