Leitfaden für technische Autoren

Aktuelle Phase:
Dokumentationsentwicklung. Siehe Zeitachse.

Dieser Leitfaden richtet sich an technische Redakteure, die mit anerkannten Organisationen im Google Season of Docs-Programm zusammenarbeiten möchten.

Sollten Sie am Google Season of Docs-Programm teilnehmen?

Die folgenden Fragen helfen Ihnen dabei, herauszufinden, ob Sie an einer Zusammenarbeit mit einer akzeptierten Organisation im Google Season of Docs-Programm interessiert sind.

  • Haben Sie technische Fähigkeiten und Erfahrung im Schreiben? Google Season of Docs ist nicht dafür gedacht, grundlegende technische Schreibfähigkeiten zu vermitteln. Sind Sie eigenmotiviert und organisiert?
  • Haben Sie in den sechs Monaten des Programms Zeit, daran teilzunehmen? Die Projektgröße variiert, reicht aber von 5 bis 30 Stunden pro Woche im Programm aus.
  • Möchten Sie Erfahrungen mit Open Source sammeln? Sind Sie bereit, Zeit zu investieren, um die Prozesse und Community-Normen eines Projekts zu erlernen?
  • Sind Sie bereit, mit dem Administrator der Organisation zusammenzuarbeiten, um seine Projektvorschläge zu optimieren, Zeitpläne zu entwickeln, Metriken zu bewerten und zusammenzustellen und dem Unternehmen als Ganzes zu helfen, den Wert technischer Texte zu verstehen?

Außerdem solltest du die Teilnahmevoraussetzungen des Programms erfüllen und in der Lage sein, ein Open Collective-Konto zu erstellen. Sie müssen rechtlich berechtigt sein, Geld für Arbeiten zu erhalten, die an Ihrem Wohnort ausgeführt werden. Die Google Season of Docs-Administratoren können keine steuerrechtliche Beratung anbieten oder Fragen zu Ihrer beruflichen Berechtigung beantworten.

Als qualifizierter technischer Redakteur, der an der "Saison of Docs" von Google teilnimmt, sammeln Sie Einnahmen, um Erfahrungen in der Arbeit mit Open Source zu sammeln, während Sie Ihr Projekt durch bessere Dokumente dabei unterstützen, einen Schlüsselbedarf zu lösen.

Teilnahme am Google-Programm „Season of Docs“ als technischer Redakteur

Erkundungsphase

Die Bewerbungsfrist für Organisationen endet am 2. April 2024 um 18:00 Uhr (UTC). Wir empfehlen technischen Autoren, so früh wie möglich mit möglichen Projekten zu beginnen. Organisationen können jedoch jederzeit vor dem 22. Mai 2024 um 18:00 Uhr (UTC) mit technischen Redakteuren zusammenarbeiten.

  • Nach Projekten suchen, die Sie interessieren
    • Wenden Sie sich direkt an Open-Source-Organisationen, indem Sie der Anleitung auf ihrer Programmseite „Google Season of Docs“ folgen. Alternativ können Sie auch das GitHub-Repository „Google Season of Docs“ aufrufen, um Organisationen zu finden, die Interesse an der Teilnahme an „Google Season of Docs“ bekundet haben. Interessierte Organisationen finden Sie möglicherweise auch im Kanal #season-of-docs unter Slack schreiben.
    • 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 interessieren, z. B. JavaScript oder C.
      • Wählen Sie ein Projekt in einer Technologie oder einem Bereich aus, der Sie interessiert, z. B. maschinelles Lernen, Open Science oder Robotik.
      • Wählen Sie ein Projekt basierend auf der Freundlichkeit der Community aus! Besuchen Sie die Diskussionsforen, sehen Sie sich die Social-Media-Konten der Mitwirkenden an (wenn sie dort über ihr Projekt sprechen) und sehen Sie sich ggf. die Onboarding-Dokumentation an.
      • Wenn Sie an einem Projekt arbeiten möchten, das nicht auf der Projektliste steht, wenden Sie sich an dieses Projekt und bitten Sie die Teammitglieder, sich zu bewerben.
  • Sehen Sie sich die Angebotsseiten der Projekte an.
    • Wenn Sie 3 bis 5 mögliche Projekte haben, sehen Sie sich die Angebotsseite jedes Projekts an
    • Sie sollten Fragen stellen, Feedback geben und Vorschläge machen, indem Sie die vom Projekt aufgeführten Kanäle für Feedback und Diskussionen verwenden.
  • Du kannst eine Interessenbekundung direkt bei der Organisation einreichen. In Ihrer Interessensbekundung erklären Sie, wie Sie die im Projektvorschlag des Unternehmens festgelegten Ziele erreichen würden.
    • Verwenden Sie die Vorlage für Interessensbekundungen von Google für die Staffel von Google Docs. Je kürzer, desto besser.
    • Folge der Anleitung auf der Seite mit den Ideen der Organisation, um deine Interessensbekundung einzureichen. Wenn das Unternehmen besondere Anforderungen aufgeführt hat, weisen Sie in Ihrer Erklärung darauf hin, dass Sie diese Anforderungen erfüllen.
    • Mit dem Absenden Ihrer Interessensbekundung erklären Sie sich damit einverstanden, den Verhaltenskodex der Organisation sowie den Verhaltenskodex von Google Season of Docs einzuhalten.

Bewerbungsphase

  • Warten Sie auf die Ankündigung der akzeptierten Organisationen in der Season of Docs:
    • Akzeptierte Organisationen werden sich direkt an Sie wenden, wenn sie mit Ihnen zusammenarbeiten oder Ihre Interessensbekundung weiter besprechen möchten.
    • Organisationen können nicht ausschließlich mit technischen Redakteuren zusammenarbeiten, die bis zum Einsendeschluss der Organisation Interessenbekundungen eingereicht haben. Nach Annahme des Angebots können sie weitere Interessensbekundungen einholen. Organisationen müssen vor dem 22. Mai 2024 um 18:00 Uhr (UTC) einen technischen Redakteur auswählen.
    • Organisationen sind nicht verpflichtet, Feedback zu erfolglosen Interessenbekundungen zu geben.

Projektentwicklungsphase

  • Erstellen Sie gemeinsam mit dem Unternehmen einen Zeitplan, der die Liefergegenstände und Fristen enthält.

Abschließende Bewertungs- und Fallstudiephase

  • Stellen Sie zusammen mit dem Unternehmen Informationen bereit, die für die abschließende Bewertung und Fallstudie erforderlich sind.