Aktuelle Phase:
Ankündigung der Ergebnisse
Zeitplan.
Diese Seite enthält Tipps für Open-Source-Organisationen, wie sie den richtigen technischen Redakteur für ihren Projektvorschlag für das Saisongeschäft von Google Docs bewerten und auswählen können.
Einführung
Open-Source-Organisationen müssen einen technischen Redakteur mit der Arbeit an ihrem vorgeschlagenen Projekt beauftragen. Die Organisationen müssen ihre eigenen technischen Redakteure engagieren. Technische Autoren, die an der Zusammenarbeit mit Organisationen interessiert sind, die am Programm „Season of Docs“ teilnehmen, finden Sie im GitHub-Repository „Season of Docs“ und im Kanal „#season-of-docs“ im Slack-Bereich „Write the Docs“.
Prozess starten
Es wird empfohlen, so bald wie möglich mit der Suche nach einem technischen Redakteur zu beginnen, wenn Sie glauben, dass Sie an „Season of Docs“ teilnehmen möchten.
Technische Redakteure bewerten
Es wird empfohlen, von den technischen Redakteuren, die Sie in Betracht ziehen, Beispiele für bereits entwickelte Dokumentationen anzufordern, damit Sie sich auf die Bewertung ihrer technischen Schreibfähigkeiten und -erfahrung konzentrieren können.
Technische Schreibfähigkeiten und -erfahrung
Prüfen Sie die Erfahrung des technischen Redakteurs. Idealerweise sollte der technische Redakteur über Vorkenntnisse in der Erstellung technischer Dokumentation für die Softwarebranche verfügen. Eines der Ziele von Season of Docs besteht darin, technischen Redakteuren die Möglichkeit zu geben, sich mit entwicklerorientierten Produkten zu beschäftigen. Aus diesem Grund ist es nicht unbedingt erforderlich, dass der Autor Erfahrung mit APIs, SDKs oder anderen Entwicklerplattformen hat, auch wenn sich Ihr Projekt an eine Zielgruppe richtet.
Konzentrieren Sie sich auf Sprach- und Kommunikationsfähigkeiten. Bewerten Sie die bisherige Arbeit des technischen Redakteurs aus diesem Blickwinkel. Sehr wichtig: Können Sie verstehen, was die Person geschrieben hat? Wenn Sie die Sprache der Arbeit des technischen Redakteurs eingehend prüfen möchten, achten Sie auf Einheitlichkeit bei Zeichensetzung und Formulierung, auf korrekte Rechtschreibung und eine klare Ausdrucksweise. Ist die Formulierung einfach oder kompliziert? Sind die Sätze kurz oder so lange, bis sie schwer zu befolgen sind?
Achten Sie auf Design und Layout der Dokumente. Überprüfen Sie das Gesamtlayout der Dokumentbeispiele. Ist das Design logisch? Können Sie sich leicht im Dokument- oder Dokumentationsset zurechtfinden? Gibt es doppelte Inhalte oder gibt es offensichtliche Lücken?
Einen technischen Redakteur beauftragen
Organisationen müssen bis zum 16. Mai 2022 um 18:00 Uhr (UTC) einen technischen Redakteur einstellen und das unten verlinkte Proof of Technical Writer Einstellungsformular ausfüllen.
Einstellungsphase für technische Redakteure abgeschlossen.
Besprechen Sie die Vergütung und den Zahlungsablauf unbedingt mit der zuständigen Redaktion, bevor Sie die Einstellung übernehmen. Wir empfehlen Organisationen, einen Zahlungsablauf mit technischen Redakteuren auf der Grundlage von Projektmeilensteinen zu erstellen, einschließlich einer Zahlung beim Projektstart. Beachten Sie die Zahlungstermine, die im Laufe des Programms nur zweimal stattfinden, und die Höhe, wenn Sie einen Zahlungsplan erstellen.
Hinweis: Organisationen, die bis zum 16. Mai 2022 um 18:00 Uhr (UTC) das Formular „Proof of Technical Writer Hiring“ nicht eingestellt und das entsprechende Formular eingereicht haben, erhalten am ersten Auszahlungsdatum keine Zahlungen.