Aktuelle Phase:
Die „Season of Docs“-Saison 2021 wurde am 14. Dezember 2021 beendet. Siehe Zeitachse.
Diese Seite enthält Tipps für Open-Source-Organisationen zur Bewertung und Auswahl der richtigen technischen Redakteure für ihren Projektvorschlag zu „Season of Docs“.
Einleitung
Open-Source-Organisationen müssen eine technische Redaktion mit der Arbeit an ihrem vorgeschlagenen Projekt einstellen. Organisationen müssen ihre eigenen technischen Redakteure beschaffen. 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 „Write the Docs“.
Technische Redakteure beurteilen
Es wird empfohlen, Beispiele für bereits entwickelte Dokumentationen von den von Ihnen in Betracht gezogenen technischen Redakteuren 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 bisherigen Erfahrungen des technischen Redakteurs. Idealerweise sollten technische Redakteure Erfahrung mit dem Schreiben technischer Dokumentation für die Softwarebranche haben. 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 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?