Aktuelle Phase:
Das Docs-Programm 2021 endete am 14. Dezember 2021. 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 einstellen. Organisationen müssen ihre eigenen technischen Redakteure stellen. Technische Redakteure, die mit Organisationen zusammenarbeiten möchten, die an der Google Season of Docs teilnehmen, finden sich im GitHub-Repository der Google Season of Docs und im #season-of-docs-Kanal in der Write the Docs Slack-Gruppe.
Technische Redakteure bewerten
Wir empfehlen Ihnen, von den infrage kommenden technischen Redakteuren Beispiele für zuvor erstellte Dokumentationen anzufordern, damit Sie sich auf die Bewertung ihrer Fähigkeiten und Erfahrungen im technischen Schreiben konzentrieren können.
Technische Schreibfä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.
Konzentriere dich auf Sprach- und Kommunikationsfähigkeiten. Bewerten Sie die bisherige Arbeit des technischen Redakteurs aus dieser Perspektive. Am wichtigsten: Können Sie verstehen, was die Person geschrieben hat? Wenn Sie die Sprache der Arbeit des technischen Redakteurs gründlich prüfen möchten, achten Sie auf Konsistenz in Zeichensetzung und Formulierung, auf korrekte Rechtschreibung und auf eine 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 Beispieldokumente. Ist das Design logisch? Können Sie sich leicht in den Dokumenten zurechtfinden? Gibt es doppelte Inhalte oder offensichtliche Lücken?