Aktuelle Phase:
Die Saison 2019 für Google Docs wurde am 6. März 2020 beendet. Siehe Zeitachse.
Diese Seite enthält Richtlinien für Open-Source-Organisationen dazu, wie sie Projektvorschläge für technisches Schreiben bewerten und die Projekte auswählen, die sie in „Season of Docs“ als Mentor anbieten möchten.
Einführung
Technische Autoren reichen ihre Vorschläge für die Saison der Docs ein, um gemeinsam mit der von ihnen ausgewählten Open-Source-Organisation an einem Projekt zu arbeiten. Die Google-Programmadministratoren leiten die Vorschläge zur Bewertung und Projektauswahl an die Open-Source-Organisationen weiter. Weitere Informationen zu den erforderlichen Schritten finden Sie im Leitfaden für den Organisationsadministrator.
Vorschläge für technische Redakteure bewerten
Technische Schreibfähigkeiten und -erfahrung
Prüfen Sie die Erfahrung des technischen Redakteurs. Der Vorschlag des technischen Redakteurs enthält Informationen über seine letzte Erfahrung im technischen Schreiben. Idealerweise sollte die Bewerber bereits Erfahrung mit dem Schreiben von 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 unbedingt erforderlich, dass der Autor Erfahrung mit APIs, SDKs oder anderen Entwicklerplattformen hat, selbst wenn sich Ihr Projekt an eine Entwickler-Zielgruppe richtet.
Konzentrieren Sie sich auf Sprach- und Kommunikationsfähigkeiten. Bewerten Sie den Vorschlag der fachkundigen Person unter diesem Gesichtspunkt. Sehr wichtig: Können Sie verstehen, was die Person geschrieben hat? Als Mentor wird es Ihre Aufgabe sein, dem technischen Redakteur bei den Open-Source-Prozessen, -Tools und -Code zu helfen. Sie möchten sich nicht auch den Text der daraus resultierenden Dokumentation durchlesen. Wenn Sie die Sprache des Vorschlags 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 laufen sie so lange weiter, bis sie schwer zu befolgen sind?
Achten Sie auf Design und Layout der Dokumente. Im Rahmen des Vorschlags hat der technische Redakteur die Möglichkeit, Beispiele für eine von ihm entwickelte Dokumentation zu nennen. Prüfen Sie das Gesamtlayout der Dokumentbeispiele. Ist das Design logisch? Finden Sie sich leicht im Dokument- oder Dokumentationspaket zurecht? Gibt es doppelte Inhalte oder offensichtliche Lücken?
Das Angebot
Prüfen Sie, ob das Angebot Ihren Anforderungen entspricht. Passend zu Ihren Projektideen, die Sie für die diesjährige Wenn der technische Redakteur eine neue Idee vorgeschlagen hat, prüfen Sie, ob der Vorschlag den Anforderungen Ihres Open-Source-Projekts entspricht und ob Sie die richtigen Personen haben, die dem technischen Redakteur beim Erreichen der Ziele des vorgeschlagenen Projekts helfen können.
Achten Sie auf Enthusiasmus und Gründlichkeit. Zeigt der Vorschlag, dass sich die technische Redakteurin für das Projekt freut? Überlegen Sie, ob die Fachkraft bereits Gedanken und Arbeit in den Vorschlag gesteckt hat, entweder durch Beratung mit Ihrem Unternehmen während der Erkundungsphase oder durch eigene Gedanken dazu, wie die Projektziele erreicht werden können.
Häufig gestellte Fragen
Wie entscheiden wir, wie viele Projekte eingereicht werden?
Konzentrieren Sie sich auf ein oder zwei Projekte. Wenn Ihre Organisation mehr Kapazitäten als Mentor hat, können Sie weitere einreichen. Für jedes Projekt als technische Redakteurin benötigen Sie mindestens eine beratende Person (vorzugsweise zwei), die ausschließlich als Mentor für dieses Projekt fungiert.
Lesen Sie die Informationen zur Funktionsweise der Slotzuweisung in „Season of Docs“.
Wie wählen wir den passenden technischen Vorschlag aus?
Wählen Sie unbedingt die besten Vorschläge für technische Redakteure aus, die Sie erhalten haben. Wählen Sie also die Vorschläge aus, die Ihren Anforderungen am besten entsprechen und die am besten zu den oben aufgeführten Bewertungsrichtlinien passen.
Wo befinden sich die Formulare, die wir für die ausgewählten Vorschläge einreichen müssen?
Weitere Informationen finden Sie im Leitfaden für den Organisationsadministrator.