Aktuelle Phase:
Fallstudien wurden veröffentlicht. Siehe Zeitachse.
Auf dieser Seite finden Sie Tipps für Open-Source-Organisationen, wie sie den richtigen technischen Redakteur für ihren Google Season of Docs-Projektvorschlag bewerten und auswählen können.
Einführung
Open-Source-Organisationen müssen einen technischen Redakteur für ihr vorgeschlagenes Projekt beauftragen. Organisationen müssen ihre eigenen technischen Redakteure stellen. Technische Redakteure, die an der Google Season of Docs teilnehmen möchten, finden im GitHub-Repository der Google Season of Docs und im #season-of-docs-Kanal in der Write the Docs Slack-Gruppe weitere Informationen.
Beginn des Prozesses
Wir empfehlen Ihnen, sobald Sie sich für die Teilnahme an Google Season of Docs interessieren, mit der Suche nach einem technischen Redakteur zu beginnen.
Technische Redakteure bewerten
Es wird empfohlen, von den infrage kommenden Technischen Redakteuren Beispiele für zuvor erstellte Dokumentationen anzufordern, damit Sie ihre Fähigkeiten und Erfahrungen im technischen Schreiben beurteilen können.
Technisches Schreiben – Fähigkeiten und Erfahrung
Prüfen Sie die bisherige Erfahrung des technischen Redakteurs. Idealerweise sollte der Technische Redakteur bereits Erfahrung im Verfassen technischer Dokumentationen für die Softwarebranche haben. Eines der Ziele der Google Season of Docs ist es, technischen Redakteuren die Möglichkeit zu geben, sich mit auf Entwickler ausgerichteten Produkten zu beschäftigen. Aus diesem Grund ist es nicht unbedingt erforderlich, dass der Texter Erfahrung mit APIs, SDKs oder anderen Entwicklerplattformen hat, auch wenn sich Ihr Projekt auf Entwickler konzentriert.
Konzentrieren Sie sich auf Sprach- und Kommunikationskompetenzen. Bewerten Sie die bisherige Arbeit des technischen Redakteurs aus dieser Perspektive. Vor allem: Können Sie verstehen, was die Person geschrieben hat? Wenn Sie die Sprache des technischen Redakteurs genauer untersuchen möchten, achten Sie auf Einheitlichkeit bei Satzzeichen und Formulierungen, korrekte Rechtschreibung und klare Sprache. Ist die Formulierung einfach oder kompliziert? Sind die Sätze kurz oder laufen sie so lange, bis sie schwer zu verstehen sind?
Achten Sie auf das Design und Layout des Dokuments. Prüfen Sie das Gesamtlayout der Dokumentbeispiele. Ist das Design logisch? Können Sie sich leicht in den Dokumenten zurechtfinden? Gibt es doppelte Inhalte oder offensichtliche Lücken?
Technische Redakteure einstellen
Organisationen müssen bis zum 22. Mai 2024 um 18:00 Uhr UTC einen technischen Redakteur einstellen und das unten verlinkte Formular zum Nachweis der Einstellung eines technischen Redakteurs ausfüllen.
Die Phase der Einstellung von technischen Redakteuren ist abgeschlossen.
Besprechen Sie vor der Einstellung die Vergütung und einen Zahlungsplan mit dem technischen Redakteur. Wir empfehlen Unternehmen, einen Zahlungsplan mit technischen Redakteuren anhand von Projektmeilensteinen zu erstellen, einschließlich einer Zahlung zu Beginn des Projekts. Berücksichtigen Sie beim Erstellen eines Zahlungsplans die Zahlungstermine, die im Rahmen des Programms nur zweimal fällig werden, und die Beträge.
Hinweis: Organisationen, die bis zum 22. Mai 2024 um 18:00 Uhr (UTC) keinen technischen Redakteur eingestellt und das Formular zum Nachweis der Einstellung eines technischen Redakteurs nicht eingereicht haben, erhalten die Zahlung nicht am ersten Auszahlungsdatum.