Leitfaden für technische Autoren

Aktuelle Phase:
Fallstudien wurden veröffentlicht. Siehe Zeitachse.

Dieser Leitfaden richtet sich an technische Redakteure, die mit ausgewählten Organisationen im Rahmen des Google Season of Docs-Programms zusammenarbeiten möchten.

Sollten Sie am Google Season of Docs-Programm teilnehmen?

Anhand dieser Fragen können Sie herausfinden, ob Sie an der Zusammenarbeit mit einer Organisation interessiert sind, die am Google Season of Docs-Programm teilnimmt.

  • Haben Sie Erfahrung im Verfassen technischer Texte? Google Season of Docs soll keine grundlegenden Fähigkeiten im technischen Schreiben vermitteln. Sind Sie selbstmotiviert und organisiert?
  • Haben Sie Zeit, während der sechsmonatigen Programmdauer teilzunehmen? Die Projektgröße variiert, aber während des Programms sind 5 bis 30 Stunden pro Woche erforderlich.
  • Möchten Sie Erfahrungen in der Open-Source-Entwicklung sammeln? Sind Sie bereit, sich Zeit zu nehmen, um die Prozesse und Community-Normen eines Projekts kennenzulernen?
  • Sind Sie bereit, mit dem Administrator der Organisation zusammenzuarbeiten, um Projektvorschläge zu optimieren, Zeitpläne zu entwickeln, Messwerte zu bewerten und zusammenzustellen und der Organisation als Ganzes den Wert von technischen Texten zu vermitteln?

Außerdem musst du die Teilnahmevoraussetzungen für das Programm erfüllen und ein Open Collective-Konto erstellen können. Sie müssen rechtlich berechtigt sein, Gelder für die in Ihrem Wohnsitzland geleistete Arbeit zu erhalten. Die Administratoren von Google Season of Docs können keine Steuerberatung anbieten oder Fragen zu Ihrer Arbeitsberechtigung beantworten.

Als erfahrener technischer Redakteur, der an der Google Season of Docs teilnimmt, erhalten Sie eine Vergütung, um Erfahrungen in der Open-Source-Entwicklung zu sammeln und gleichzeitig mithilfe besserer Dokumente eine wichtige Anforderung Ihres Projekts zu erfüllen.

Als technischer Redakteur am Google Season of Docs-Programm teilnehmen

Explorative Datenanalyse

Die Bewerbungsfrist für Organisationen endet am 2. April 2024 um 18:00 Uhr (UTC). Wir empfehlen technischen Redakteuren, sich möglichst frühzeitig mit möglichen Projekten zu befassen. Organisationen können jedoch jederzeit vor dem 22. Mai 2024 um 18:00 Uhr (UTC) technische Redakteure auswählen, mit denen sie zusammenarbeiten möchten.

  • Projekte finden, die Sie interessieren
    • Sie können Open-Source-Organisationen direkt über die Anleitung auf der Programmseite von Google Season of Docs kontaktieren oder im GitHub-Repository von Google Season of Docs nach Organisationen suchen, die ihr Interesse an der Teilnahme an Google Season of Docs bekundet haben. Im Write the Docs Slack-Kanal #season-of-docs finden Sie möglicherweise auch interessierte Organisationen.
    • So können Sie ein Projekt auswählen:
      • Wählen Sie ein Projekt in einer Sprache aus, mit der Sie vertraut sind oder die Sie interessiert, z. B. JavaScript oder C.
      • Wählen Sie ein Projekt in einer Technologie oder Domain aus, die Sie interessiert, z. B. maschinelles Lernen, Open Science oder Robotik.
      • Wählen Sie ein Projekt anhand der Freundlichkeit der Community aus. Besuchen Sie die Diskussionsforen, sehen Sie sich die Social-Media-Konten der Mitwirkenden an (falls sie dort über ihr Projekt sprechen) und sehen Sie sich die Onboarding-Dokumentation an, falls vorhanden.
      • Wenn du an einem Projekt mitarbeiten möchtest, das nicht in der Projektliste aufgeführt ist, wende dich an das Projekt und bitte um eine Bewerbung.
  • Die Projektvorschlagsseiten ansehen
    • Sobald Sie 3 bis 5 mögliche Projekte gefunden haben, sehen Sie sich die Projektseite mit dem Vorschlag an.
    • Sie sollten Fragen stellen, Feedback geben und Vorschläge machen. Verwenden Sie dazu die für Feedback und Diskussionen vorgesehenen Kanäle des Projekts.
  • Reichen Sie ein Interessenbekenntnis direkt bei der Organisation ein. In Ihrer Interessenbekundung zeigen Sie, wie Sie die im Projektvorschlag der Organisation festgelegten Ziele erreichen würden.
    • Verwenden Sie die Vorlage für das Bekenntnis zur Teilnahme an Google Season of Docs. Je kürzer, desto besser.
    • Folgen Sie der Anleitung auf der Ideenseite der Organisation, um Ihr Interesse zu bekunden. Wenn die Organisation besondere Anforderungen aufgeführt hat, müssen Sie in Ihrer Erklärung nachweisen, dass Sie diese erfüllen.
    • Durch das Einreichen Ihrer Interessenbekundung erklären Sie sich damit einverstanden, den Verhaltenskodex der Organisation und den Verhaltenskodex von Google Season of Docs einzuhalten.

Antragsphase

  • Warten Sie auf die Bekanntgabe der zugelassenen Organisationen durch Google Season of Docs:
    • Akzeptierte Organisationen setzen sich direkt mit Ihnen in Verbindung, wenn sie mit Ihnen zusammenarbeiten oder Ihre Interessenbekundung weiter besprechen möchten.
    • Organisationen sind nicht darauf beschränkt, nur mit technischen Redakteuren zusammenzuarbeiten, die bis zum Bewerbungstermin der Organisation ein Interessenbekenntnis eingereicht haben. Nach der Annahme kann es weitere Interessenbekundungen geben. Organisationen müssen vor dem 22. Mai 2024 um 18:00 Uhr (UTC) einen technischen Redakteur auswählen.
    • Organisationen sind nicht verpflichtet, Feedback zu abgelehnten Interessenbekundungen zu geben.

Phase der Projektentwicklung

  • Erstellen Sie gemeinsam mit der Organisation einen Zeitplan mit den zu erbringenden Leistungen und den Terminen.

Endgültige Bewertung und Fallstudienphase

  • Erarbeiten Sie gemeinsam mit der Organisation die Informationen, die für die endgültige Bewertung und Fallstudie erforderlich sind.