Leitfaden für technische Autoren

Aktuelle Phase:
Ankündigung der Ergebnisse Zeitplan.

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

Sollten Sie am Programm „Season of Docs“ teilnehmen?

Mithilfe der folgenden Fragen können Sie herausfinden, ob Sie an der Zusammenarbeit mit einem anerkannten Unternehmen im Season of Docs-Programm interessiert sind.

  • Haben Sie technische Schreibfähigkeiten und -erfahrung? „Season of Docs“ ist nicht dazu gedacht, grundlegende technische Schreibfähigkeiten zu vermitteln. Bist du selbstmotiviert und organisiert?
  • Haben Sie während der sechs Monate des Programms Zeit für die Teilnahme? Die Projektgrößen variieren, reichen jedoch von einem Aufwand von 5 bis 30 Stunden pro Woche während des Programms.
  • 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 verfeinern, Zeitpläne zu entwickeln, Metriken zu bewerten und zusammenzustellen und dem Unternehmen als Ganzes zu helfen, den Wert des technischen Schreibens zu verstehen?

Außerdem solltest du die Teilnahmevoraussetzungen des Programms erfüllen und unter anderem ein Open Collective-Konto erstellen können. Bitte beachten Sie, dass Sie rechtlich dazu in der Lage sein müssen, Zahlungen für die an Ihrem Wohnort geleistete Arbeit zu erhalten. Die Administratoren des Programms „Season of Docs“ können keine Steuerberatung anbieten oder Fragen zu Ihrer beruflichen Berechtigung beantworten.

Als qualifizierter technischer Redakteur bei der Teilnahme an „Season of Docs“ werden Sie dafür bezahlt, Erfahrung mit Open Source zu sammeln, während Sie Ihr Projekt durch bessere Dokumente bei der Lösung eines wichtigen Bedarfs unterstützen.

Teilnahme am Programm „Season of Docs“ als technischer Redakteur

Erkundungsphase

Die Bewerbungsfrist für Organisationen endet am 25. März 2022 um 18:00 Uhr (UTC). Wir empfehlen technischen Redakteuren, mögliche Projekte so früh wie möglich zu untersuchen. Allerdings können Organisationen jederzeit vor dem 16. Mai 2022 um 18:00 Uhr (UTC) technische Redakteure auswählen.

  • Projekte finden, die Sie interessieren
    • Wenden Sie sich direkt an Open-Source-Organisationen. Folgen Sie dazu der Anleitung auf ihrer Programmseite „Season of Docs“ oder suchen Sie im GitHub-Repository „Season of Docs“ nach Organisationen, die Interesse an einer Teilnahme an „Season of Docs“ bekundet haben. Interessierte Organisationen finden Sie möglicherweise auch im Kanal #season-of-docs unter Dokumente in Slack schreiben.
    • Sie haben folgende Möglichkeiten, ein Projekt auszuwä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ähle ein Projekt in einer Technologie oder einem Bereich aus, der dich interessiert, z. B. maschinelles Lernen, Open Science oder Robotik.
      • Wähle ein Projekt aus, das auf der Freundlichkeit der Community basiert! Besuchen Sie die Diskussionsforen, sehen Sie sich die Konten der Mitwirkenden in den sozialen Medien an (falls sie dort über ihr Projekt sprechen) und sehen Sie sich gegebenenfalls die Onboarding-Dokumentation an.
      • Wenn Sie mit einem Projekt arbeiten möchten, das nicht auf der Projektliste steht, wenden Sie sich an dieses Projekt und bitten Sie um eine Bewerbung.
  • Überprüfen Sie die Angebotsseiten der Projekte.
    • Wenn Sie 3 bis 5 mögliche Projekte haben, sehen Sie sich die Vorschlagsseite des jeweiligen 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 zur Diskussion nutzen.
  • Du kannst eine Interessenbekundung direkt bei der Organisation einreichen. In Ihrer Interessensbekundung erklären Sie, wie Sie die im Projektvorschlag der Organisation festgelegten Ziele erreichen würden.
    • Verwenden Sie dazu die Vorlage für die Interessenbekundung. Je kürzer, desto besser.
    • Folge der Anleitung auf der Seite mit den Ideen der Organisation, um deine Interessensbekundung einzureichen. Wenn die Organisation besondere Anforderungen aufgeführt hat, müssen Sie in Ihrer Erklärung nachweisen, dass Sie diese Anforderungen erfüllen.
    • Durch das Einreichen Ihrer Interessensbekundung erklären Sie sich damit einverstanden, den Verhaltenskodex der Organisation und den Verhaltenskodex „Season of Docs“ einzuhalten.

Bewerbungsphase

  • Warten Sie auf die Bekanntgabe der akzeptierten Organisationen nach Saison von Google Docs:
    • Akzeptierte Organisationen werden sich direkt an Sie wenden, wenn sie mit Ihnen zusammenarbeiten oder Ihre Interessensbekundung weiter besprechen möchten.
    • Organisationen sind nicht auf die Zusammenarbeit mit technischen Redakteuren beschränkt, die innerhalb der Bewerbungsfrist der Organisation Interessenbekundungen eingereicht haben. Nach Annahme der Einladung können sie weitere Interessensbekundungen einholen. Die Organisationen müssen vor dem 16. Mai 2022 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 Fallstudie

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