Aktuelle Phase:
Dokumentationsentwicklung. Siehe Zeitachse.
Diese Seite enthält Tipps für Open-Source-Organisationen zur Bewertung und Auswahl des richtigen technischen Redakteurs für ihren Projektvorschlag zur Serie „Season of Docs“ von Google.
Einleitung
Open-Source-Organisationen müssen einen technischen Redakteur mit der Arbeit an ihrem vorgeschlagenen Projekt beauftragen. Organisationen müssen ihre eigenen technischen Redakteure beschaffen. Technische Autoren, die an der Zusammenarbeit mit Organisationen interessiert sind, die am Programm „Google Season of Docs“ teilnehmen, finden Sie im GitHub-Repository „Google Season of Docs“ und im Kanal „#season-of-docs“ im Slack „Write the Docs“.
Prozess starten
Es wird empfohlen, so bald wie möglich mit der Suche nach einem technischen Redakteur zu beginnen, wenn Sie an der Staffel von Google Docs teilnehmen möchten.
Technische Redakteure beurteilen
Es wird empfohlen, Beispiele für bereits entwickelte Dokumentationen von den von Ihnen in Betracht gezogenen technischen Redakteuren anzufordern, damit Sie ihre technischen Schreibfähigkeiten und -erfahrung bewerten können.
Technische Schreibfähigkeiten und -erfahrung
Prüfen Sie die bisherigen Erfahrungen des technischen Redakteurs. Idealerweise sollten technische Redakteure Erfahrung mit dem Schreiben technischer Dokumentation für die Softwarebranche haben. Eines der Ziele von Google Season of Docs ist es, technischen Redakteuren die Möglichkeit zu geben, sich mit entwicklerorientierten Produkten zu beschäftigen. Aus diesem Grund ist es nicht wichtig, 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 unter diesem Gesichtspunkt. Und das Wichtigste: Kannst du verstehen, was die Person geschrieben hat? Wenn Sie die Sprache der Arbeit eines technischen Redakteurs genau prüfen möchten, achten Sie auf Einheitlichkeit bei Zeichensetzung und Formulierung, auf korrekte Rechtschreibung und eine klare Sprache. Ist die Formulierung einfach oder kompliziert? Sind die Sätze kurz oder laufen sie so lange, bis sie schwer zu folgen 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 Dokumentationspaket zurechtfinden? Gibt es doppelte Inhalte oder offensichtliche Lücken?
Einen technischen Redakteur beauftragen
Organisationen müssen bis zum 22. Mai 2024 um 18:00 Uhr (UTC) einen technischen Redakteur einstellen und das unten verlinkte Formular „Proof of Technical Writer“ ausfüllen.
Formular für die Einstellung von technischen Redakteuren
Besprechen Sie die Vergütung und den Zahlungsablauf mit der Fachkraft für technische Redakteure, bevor Sie sie beauftragen. Wir empfehlen Organisationen, einen Zahlungsplan mit technischen Redakteuren auf der Grundlage von Projektmeilensteinen zu erstellen, einschließlich einer Zahlung beim Projektstart. Beachten Sie die Zahlungstermine, die während des gesamten Programms nur zweimal stattfinden, und die Beträge, wenn Sie einen Zahlungsplan erstellen.
Hinweis: Organisationen, die bis zum 22. Mai 2024 um 18:00 Uhr UTC kein „Tech Writer“ eingestellt und das Formular „Proof of Technical Writer Hiring“ eingereicht haben, erhalten am ersten Auszahlungsdatum keine Mittel.