Anwendung für technisches Schreiben erstellen

Aktuelle Phase:
Die Saison 2019 für Google Docs wurde am 6. März 2020 beendet. Siehe Zeitachse.

Diese Seite enthält Tipps für technische Redakteure, wie sie die wichtigsten Bestandteile einer Bewerbung für „Season of Docs“ ausfüllen können. Diese Informationen helfen Ihnen zu verstehen, welche Faktoren die Open-Source-Organisationen berücksichtigen können, wenn sie die technischen Schreibprojekte auswählen, die sie während der Season of Docs als Mentor anbieten möchten.

Einführung

Die folgenden Richtlinien gelten allgemein für die Vorlage „Staffel von Dokumenten“. Jede Open-Source-Organisation kann spezifische Bewertungskriterien haben. Sie können sich vor dem Einreichen Ihrer Bewerbung mit einer der teilnehmenden Organisationen in Verbindung setzen, um deren Anforderungen zu besprechen und Ihren Projektvorschlag zu planen. Weitere Informationen finden Sie in der explorativen Phase der explorativen Datenanalyse für technische Autoren.

Das Antragsformular

Das Antragsformular steht während der Bewerbungsphase im Leitfaden für technische Redakteure zur Verfügung.

Nach dem Absenden des Formulars können Sie die Informationen im Formular bis zum Ende der Bewerbungsphase (28. Juni 2019) weiter aktualisieren.

Personenbezogene Daten

Im Antragsformular werden die folgenden personenbezogenen Daten abgefragt:

  • Ihr Name:Geben Sie Ihren vollständigen Namen an. Season of Docs gibt diesen Namen nicht an die Open-Source-Organisationen weiter und veröffentlicht ihn auch nicht auf der Website.

  • Anzeigename Ihrer Wahl:Geben Sie den Namen an, den Sie während der Teilnahme an „Season of Docs“ als öffentliche Kennung verwenden möchten. Wir empfehlen dringend, nicht Ihren echten, vollständigen Namen als Anzeigenamen zu verwenden. Season of Docs gibt Ihren Anzeigenamen für die Open-Source-Organisation frei, die Sie im Antragsformular angeben. Bei „Season of Docs“ wird Ihr Anzeigename auf der Website in der Liste der akzeptierten Projekte für technisches Schreiben veröffentlicht.

  • Ihre E-Mail-Adresse: Geben Sie die E-Mail-Adresse an, die mit Ihrem Google-Konto verknüpft ist. (Sie benötigen ein Google-Konto, um an Season of Docs teilnehmen zu können. Sie können eine E-Mail-Adresse, die nicht von Gmail stammt, mit einem Google-Konto verwenden. Weitere Informationen finden Sie in diesem Hilfeartikel. Ihre E-Mail-Adresse wird von Season of Docs verwendet, um mit Ihnen zu kommunizieren und Ihnen die Websiteressourcen zur Verfügung zu stellen. Season of Docs gibt diese E-Mail-Adresse an die Open-Source-Organisation weiter, die Sie im Antragsformular angegeben haben. Diese E-Mail-Adresse wird nicht auf der Website veröffentlicht.

Unten finden Sie eine Zusammenfassung dazu, wie Season of Docs die Informationen aus Ihrem Antragsformular verwendet.

Informationen zu Ihren Erfahrungen beim technischen Schreiben

Wenn die Open-Source-Mentoren und Organisationsadministratoren einen Projektvorschlag prüfen, interessieren sie sich für Ihre technische Erfahrung im Schreiben. Sie können folgende Details im Formular angeben:

  • Aktuelle Erfahrung beim technischen Schreiben:Bis zu drei Einträge, in denen Sie Ihre letzten technischen Tätigkeiten oder Berufserfahrung auflisten können. Wenn Sie Erfahrung mit Open-Source-Dokumentation haben, fügen Sie diese hier hinzu. Fassen Sie Ihre Rolle, die Verantwortlichkeiten dieser Rolle und die geleistete Arbeit zusammen. Sie können ggf. Datumsangaben angeben.

  • Link zu Ihrem Lebenslauf:(optional) Die URL einer öffentlich zugänglichen Version Ihres Lebenslaufs oder Curriculum Vitae.

  • Ein Link zu Ihren Arbeitsbeispielen:(optional) Die URL eines öffentlich zugänglichen Portfolios mit Schreibbeispielen oder einzelne Links zu Beispielen Ihrer Arbeit.

  • Weitere Informationen: (Optional) Alle Informationen, die Sie der App hinzufügen möchten. z. B. Ihr Interesse an der technischen Dokumentation, warum Sie an „Season of Docs“ teilnehmen möchten, oder andere relevante Erfahrungen.

Projektvorschlag

Ihr Projektvorschlag ist eine Zusammenfassung der Dokumentationsarbeiten, die Sie bei der Arbeit mit Ihrer ausgewählten Open-Source-Organisation während der „Saison of Docs“ durchführen möchten.

Du kannst maximal drei Projektvorschläge einreichen. Alle Projektvorschläge müssen auf demselben Antragsformular gespeichert sein.

Nehmen Sie sich Zeit für Ihren Projektvorschlag und beachten Sie dabei die folgenden Richtlinien.

Vorbereitende Arbeiten:

  • Sehen Sie sich die Liste der teilnehmenden Open-Source-Organisationen an und wählen Sie eine oder mehrere Organisationen aus, die Sie interessieren. Sehen Sie sich die Projektideen an, die jede Ihrer ausgewählten Open-Source-Organisationen vorgeschlagen hat.

    Teilnehmende Open-Source-Organisationen

  • Wenn die für Sie interessante Organisation keine Ideen vorgeschlagen hat, können Sie die allgemeine Liste der Projektideen prüfen und Ihre Idee auf einer dieser Ideen stützen. Sie können sich auch Ihre eigene Idee einfallen lassen, unabhängig davon, ob das Unternehmen Ideen veröffentlicht hat oder nicht.

  • Setzen Sie sich mit einer oder mehreren der teilnehmenden Organisationen in Verbindung, um die Projektideen zu besprechen. Verwenden Sie dazu die E-Mail-Adresse der Organisation, die in der Liste der teilnehmenden Organisationen angezeigt wird. Frühzeitige Diskussionen helfen Ihnen, einen guten Projektvorschlag zu erstellen.

Ihr Projektvorschlag im Antragsformular:

  • Name der Open-Source-Organisation:Geben Sie den Namen der Open-Source-Organisation ein, mit der Sie in der Phase „Season of Docs“ arbeiten möchten. Dabei muss es sich um eine der teilnehmenden Organisationen handeln, die auf der Website „Season of Docs“ aufgeführt sind.

    Teilnehmende Open-Source-Organisationen

  • Name des Open-Source-Projekts:Dies ist der Name des Open-Source-Projekts, an dem Sie während der Saison arbeiten möchten. Das Projekt muss einer der teilnehmenden Organisationen gehören, die auf der Website „Season of Docs“ aufgeführt sind. Bei einigen Organisationen können der Organisationsname und der Projektname identisch sein.

  • Der Name Ihres geplanten Projekts für technisches Schreiben. Geben Sie einen kurzen, beschreibenden Titel ein, der das Hauptziel Ihrer Arbeit zusammenfasst.

  • Eine ausführliche Beschreibung Geben Sie in der Beschreibung Ihres Projekts so viele Details wie möglich an. Sie können mehrere Absätze in das Beschreibungsfeld eingeben. Hier einige Vorschläge dazu, was enthalten sein könnte:

    • Geben Sie Details zu der Dokumentation an, die Sie erstellen bzw. aktualisieren möchten. Wenn Sie ein vorhandenes Dokument oder eine vorhandene Website aktualisieren möchten, fügen Sie einen Link hinzu und beschreiben Sie die vorgeschlagenen Aktualisierungen. Wenn Sie ein neues Dokument oder eine neue Website vorschlagen, beschreiben Sie den Inhalt und die Zielgruppe.
    • Erläutern Sie, warum Sie die neue Dokumentation oder die Aktualisierungen vorschlagen.
    • Wenn Sie das Projekt mit jemandem aus der Open-Source-Organisation besprochen haben, fügen Sie eine Zusammenfassung der Ergebnisse dieser Gespräche hinzu.
    • Achten Sie auf die Formulierung und den Stil Ihres Vorschlags. Die Open-Source-Organisation kann diese bei der Bewertung des Vorschlags berücksichtigen.
    • Geben Sie keinen Link zu Ihrer Projektbeschreibung an. Die Beschreibung sollte alle maßgeblichen Details Ihres Projekts enthalten. Die Open-Source-Organisation muss in der Lage sein, eine Auswahl auf der Grundlage des Inhalts des Antragsformulars zu treffen, nicht auf der Grundlage von Inhalten, die an anderer Stelle gespeichert sind. Wenn Sie Links zu anderen Inhalten einfügen müssen, die die Beschreibung ergänzen, ist das in Ordnung. Beachten Sie jedoch, dass nur der Inhalt des Bewerbungsformulars für die Projektauswahl verwendet wird.

Weitere wichtige Felder im Antragsformular

Im Folgenden finden Sie Richtlinien zu anderen wichtigen Informationen, die Sie auf dem Antragsformular angeben sollten:

  • Projekt mit Standardlänge oder langer Laufzeit auswählen:Der Standardzeitraum für die Dokumententwicklungsphase von „Season of Docs“ beträgt drei Monate. Wenn Ihr Projekt einen längeren Zeitraum benötigt, müssen Sie dies nach Rücksprache mit der Open-Source-Organisation Ihrer Wahl im Antragsformular angeben. Weitere Informationen finden Sie in der Beschreibung von Projekten mit langer Ausführungszeit.

  • Das Stipendium für die Saison von Google Docs akzeptieren: Für die Season of Docs wird eine Geldsumme an technische Redakteure ausbezahlt, die ihre Projekte erfolgreich abschließen, vorausgesetzt, der technische Redakteur möchte das Stipendium annehmen. Weitere Informationen finden Sie unter Stipendien für technische Redakteure. Das Stipendium ist optional. Wenn Sie das Stipendium nicht erhalten möchten, geben Sie Ihre Entscheidung im Antragsformular an.

So verwendet Season of Docs die Informationen aus Ihrem Antragsformular

In diesem Abschnitt wird zusammengefasst, wie „Season of Docs“ die Informationen aus Ihrem Antragsformular verwendet. In früheren Abschnitten auf dieser Seite wurden die wichtigsten Felder ausführlich beschrieben.

In der Tabelle sind die wichtigsten Felder aufgeführt. Die Tabelle gibt für jedes Feld an, ob die Datei „Season of Docs“:

  • Übergibt die Informationen an die Open-Source-Organisation, die Sie im Antragsformular angegeben haben.
  • Veröffentlicht die Informationen in der Liste der akzeptierten Projekte für technisches Schreiben auf der Website „Season of Docs“.
Informationen im Formular Für Open-Source-Organisation freigegeben? Wird auf der Website von Staffel von Google Docs angezeigt?
vollständiger Name
Anzeigename
E-Mail-Adresse
Erfahrung beim Verfassen von technischen Texten
Link zum Lebenslauf
Link zu Arbeitsbeispielen
Möchten Sie noch etwas hinzufügen?
Name der Open-Source-Organisation/des Open-Source-Projekts
Projektname und -beschreibung für technisches Schreiben
Lang andauerndes Projekt oder Projekt mit Standardlänge
Annahme des Stipendiums

Erläuterung der in der obigen Tabelle verwendeten Symbole:

Symbol Bedeutung von Symbolen
Ja
Nein

Hinweise

Weitere Hinweise:

  • Mehrere Projektvorschläge einreichen:Sie können mehrere Projektvorschläge einreichen. Für die Sammlung „Season of Docs“ wird jedoch nur ein Projektvorschlag pro technischem Redakteur akzeptiert. Sie können nur ein Antragsformular einreichen. Das Formular kann bis zu drei Projektvorschläge umfassen.

  • Gesamtzahl der technischen Schreibprojekte im Programm:Für die Docs-Staffel kann insgesamt nur eine bestimmte Höchstzahl von technischen Projekten akzeptiert werden. Weitere Informationen zur Slot-Zuweisung

  • Sieh dir die Tipps für Mentoren zur Bewertung von Vorschlägen für technische Redakteure an. Wenn Sie die Auswahlkriterien der beratenden Personen kennen, können Sie ein Angebot erstellen, das mit größerer Wahrscheinlichkeit erfolgreich ist.

  • Verfahrensbezogene Informationen dazu, wann und wie Sie Ihre Bewerbung für die Staffel von Google Docs einreichen, finden Sie im Leitfaden für technische Redakteure.