FAQ

Aktuelle Phase:
Fallstudien wurden veröffentlicht. Siehe Zeitachse.

Allgemein

Ist Google Season of Docs ein Recruiting-Programm?

Nein. Wenn Sie für Google arbeiten möchten, besuchen Sie die Google Jobs-Website.

Unsere Organisation möchte an der Google Season of Docs teilnehmen, weiß aber nicht, wo sie anfangen soll.

Hier finden Sie eine vollständige Liste unserer Projektideen. Sie können sich auch an die Community für technisches Schreiben wenden. Versuchen Sie es mit dem Kanal #season-of-docs im Write the Docs-Slack oder in Ihren Social-Media-Kanälen, um Hilfe oder Vorschläge zu erhalten.

Welche Arten von Projekten können Organisationen vorschlagen?

Hier einige Vorschläge:

  • Erstellen Sie eine Dokumentationswebsite auf einer Plattform, die vom technischen Redakteur und der Open-Source-Organisation festgelegt wird, und veröffentlichen Sie eine erste Reihe grundlegender Dokumente auf der Website. Beispiele für Plattformen:

  • Refaktorisieren Sie die vorhandene Dokumentation des Open-Source-Projekts, um eine verbesserte Nutzererfahrung oder eine barrierefreiere Informationsarchitektur zu ermöglichen.

  • Verfassen Sie eine Konzeptübersicht oder Einführung in ein Produkt oder eine Funktion. Oft erstellt ein Team seine technische Dokumentation von unten nach oben. Das führt dazu, dass es viele Details gibt, aber das Produkt als Ganzes schwer zu verstehen ist. Ein Technischer Redakteur kann das Problem beheben.

  • Erstellen Sie eine Anleitung für einen bekannten Anwendungsfall.

  • Erstellen Sie eine Reihe von Anleitungen für bestimmte Aufgaben.

  • Erstellen Sie einen Leitfaden für Mitwirkende, der grundlegende Informationen zum Einstieg als Mitwirkender am Open-Source-Projekt sowie alle Regeln zu Lizenzvereinbarungen, Prozessen für Pull-Requests und Überprüfungen, zum Erstellen des Projekts usw. enthält.

Ist ein Video ein mögliches Projekt für die Google Season of Docs?

Ja. Achten Sie darauf, dass die Videoanforderungen gut definiert sind. Die Produktion eines hochwertigen Videos erfordert viel Zeit und Ressourcen.

Ist eine Dokumentationsprüfung ein angemessenes Projekt für die Google Season of Docs?

Eine Dokumentationsprüfung ist ein tolles Projekt für die Google Season of Docs. Berücksichtigen Sie, wie viel Dokumentation Sie bereits haben. Wenn Sie viel haben, müssen Sie den Umfang möglicherweise reduzieren, z. B. nur die Inhalte des Tutorials prüfen. Wenn Sie nur wenig oder gar keine Dokumentation haben, sollten Sie die Erstellung der fehlenden Dokumentation mit der höchsten Priorität in Ihr Projekt aufnehmen.

Gibt es Dokumentationsvorlagen für Organisationen und technische Redakteure?

Google Season of Docs hat ein GitHub-Repository mit einer Vorlage und Checkliste für die Durchführung von Dokumentenprüfungen. Weitere Vorlagen werden hinzugefügt, sobald sie erstellt wurden.

Das Good Docs Project arbeitet an der Erstellung von Vorlagen für Minimum Viable Documentation für Open Source.

Müssen Organisationen die von technischen Redakteuren erstellten Dokumente verwenden?

Nein. Gelegentlich laufen Projekte nicht wie erwartet ab oder die Anforderungen ändern sich. Organisationen müssen die erstellte Dokumentation oder andere Materialien nicht verwenden. Wir erwarten jedoch, dass die endgültige Bewertung und Fallstudie eine Erläuterung dazu enthält, warum die Dokumentation nicht verwendet wurde und wie die Entscheidung getroffen wurde, die Dokumentation oder andere Materialien nicht zu verwenden.

Wo findet die Google Season of Docs statt?

Die Google Docs-Saison findet ausschließlich online statt. Im Rahmen des Programms ist keine Reise erforderlich.

Wie kann ich über die Google Season of Docs auf dem Laufenden bleiben?

Die neuesten Updates und Ankündigungen zu Google Season of Docs finden Sie in der Ankündigungs-Mailingliste unter season-of-docs-announce. Treten Sie der Gruppe bei, um E-Mail-Updates zu erhalten.

Kann ich den Zeitplan für die Google Season of Docs meinem Kalender hinzufügen?

Unter http://goo.gle/2NeZVew können Sie den Google Season of Docs-Kalender abonnieren.

Was kann ich tun, um die Google Season of Docs bekannter zu machen?

Sie können über das Programm twittern, Blogbeiträge verfassen, Videos veröffentlichen oder ein Treffen oder eine Informationsveranstaltung in Ihrer Nähe veranstalten. Wir haben einige Beispielinhalte und Ressourcen, die Sie in Ihrer Community (Organisation, Autorengruppe und andere Kontakte) verteilen können.

Wie kann ich eine Informationsveranstaltung oder ein Meetup zu Google Season of Docs organisieren oder veranstalten?

Sie können einen Termin zu einer beliebigen Zeit und an einem beliebigen Ort vereinbaren. Lies dir die Programmregeln durch und verwende die Beispielinhalte.

Gibt es Statistiken zu den Programmen von 2019 und 2020?

Ja, die Ergebnisse der Google Season of Docs für das Programm 2019 können im Google Open Source Blog eingesehen werden (2019, 2020).

Erhalte ich ein T-Shirt von Google Season of Docs?

Nein. Aufgrund von Einschränkungen beim internationalen Versand können wir den Teilnehmern, die ihr Google Season of Docs-Projekt erfolgreich abgeschlossen haben, keine T-Shirts mehr zur Verfügung stellen.

Ich habe weitere Fragen. Was kann ich tun?

Weitere Informationen finden Sie im Leitfaden für Nutzer mit der Rolle „Organization Administrator“ und im Leitfaden für technische Redakteure.

Wenn Sie nach dem Lesen der gesamten Dokumentation immer noch keine Antwort gefunden haben, können Sie Ihre Fragen in der Diskussionsliste mit der Google Season of Docs-Community besprechen. Weitere Informationen zu Diskussionskanälen und zur Kontaktaufnahme

Wie kann ich Mentor für Google Season of Docs werden?

Bei Google Season of Docs gibt es keine formelle Mentorrolle. Organisationen sollten angeben, wie technische Redakteure eingearbeitet und unterstützt werden und wie ihre Dokumentationsbeiträge im Rahmen des Antrags der Organisation geprüft und genehmigt werden. Wenn Sie als Mentor für technische Redakteure im Rahmen von Google Season of Docs tätig werden möchten, wenden Sie sich an die Administratoren Ihrer Organisation, um sich als Freiwilliger zu melden.

Ist Google Season of Docs mit Google Summer of Code vergleichbar?

Nein. Google Season of Docs richtet sich an Personen mit etwas Erfahrung im technischen Schreiben. Es ist kein Mentoring-Programm wie Google Summer of Code.

Für technische Redakteure

Wann können sich Technische Redakteure für Google Season of Docs bewerben?

Für Google Season of Docs gibt es keine formelle Bewerbung für technische Redakteure. Wenn Sie als Technischer Redakteur an der Google Season of Docs teilnehmen möchten, wenden Sie sich direkt an Open-Source-Organisationen. Folgen Sie dazu der Anleitung auf der Programmseite der Google Season of Docs. Sie können auch Ihr Interesse bekunden, indem Sie sich in das Directory für technische Redakteure von Google Season of Docs eintragen. Weitere Informationen finden Sie im Leitfaden für technische Redakteure.

Welche Dokumentationstools und ‑frameworks sollte ich kennen, um an der Google Season of Docs teilzunehmen?

Welche Dokumentationstools und ‑frameworks Sie verwenden, hängt von der Organisation ab, für die Sie arbeiten möchten. Ein Ziel der Google Season of Docs besteht darin, dass die Open-Source-Projekte technischen Redakteuren helfen, mehr über die Tools und Frameworks zu erfahren, die bei der Dokumentation von Open-Source-Produkten zum Einsatz kommen. Aus diesem Grund ist es in der Regel nicht erforderlich, dass Sie detaillierte Kenntnisse über bestimmte Dokumentationsplattformen haben, bevor Sie mit Ihrem Google Season of Docs-Projekt beginnen.

Die meisten Open-Source-Organisationen verwenden jedoch eine Variante von Markdown oder eine andere Markup-Sprache für ihre Dokumentation. Wir empfehlen Ihnen, herauszufinden, welche Sprache die von Ihnen ausgewählte Organisation verwendet, und sich mit der Syntax vertraut zu machen. Markdown ist ein guter Ausgangspunkt, da GitHub-README-Dateien eine Variante von Markdown verwenden. Weitere Informationen finden Sie im GitHub-Leitfaden zu Markdown.

Finden Sie heraus, ob die von Ihnen ausgewählte Organisation ihre Dokumentation bereits auf einer Website hostet und falls ja, welche Plattform sie verwendet. Die Plattform kann ein Generator für statische Websites wie Jekyll, Sphinx oder Hugo sein. Die Organisation kann ihre Dokumente auch auf Read the Docs oder GitHub Pages hosten. Wenn Sie herausgefunden haben, welche Plattform das Unternehmen verwendet, sollten Sie sich mit der entsprechenden Sprache und dem entsprechenden Framework vertraut machen und damit experimentieren. So können Sie schnell mit Ihrem Open-Source-Projekt beginnen und fundierte Ratschläge für das Open-Source-Projekt Ihrer Wahl geben.

Welche Programmiersprachen sollte ich beherrschen, um an den Google Season of Docs-Projekten teilnehmen zu können?

Je nach Art Ihres Dokumentationsprojekts müssen Sie möglicherweise mit einer Programmiersprache vertraut sein. Berücksichtigen Sie dies bei der Auswahl und dem Vorschlag eines Dokumentationsprojekts und erkundigen Sie sich bei der Open-Source-Organisation nach dem erforderlichen Kenntnisstand.

Können technische Redakteure, die bereits an einem Open-Source-Projekt arbeiten, im Rahmen der Google Season of Docs weiter daran arbeiten?

Ja, aber die Organisation sollte in ihrem Angebot die bisherige oder laufende Beziehung des technischen Redakteurs zum Projekt angeben.

Welche Voraussetzungen gelten für die Teilnahme?

Brauche ich Vorkenntnisse oder eine Ausbildung als technischer Redakteur?

Vorkenntnisse oder eine Ausbildung im technischen Schreiben sind wünschenswert, aber nicht unbedingt erforderlich. Wenn Sie einer Organisation ein Interessenbekenntnis senden, können Sie Ihre Erfahrung oder Schulungen im Bereich technisches Schreiben beschreiben. Sie sollten Nachweise erbringen können, die Ihr Interesse an technischer Dokumentation oder Open-Source-Dokumentation belegen, einschließlich Beispiele für von Ihnen verfasste Dokumentationen. Die Open-Source-Organisation sucht nach technischen Redakteuren mit der entsprechenden Erfahrung, um die Google Season of Docs-Projekte erfolgreich abzuschließen.

Werde ich für die Teilnahme an der Google Season of Docs bezahlt?

Ja. Google vergibt Zuschüsse an die ausgewählten Organisationen, die sie für die Einstellung von technischen Redakteuren verwenden können.

Wie sieht eine gute Interessenbekundung für technische Redakteure aus?

Die besten Interessenbekundungen stammen von technischen Redakteuren, die sich die Zeit nehmen, mit der von ihnen ausgewählten Open-Source-Organisation zu interagieren und ihre Ideen mit ihr zu besprechen, bevor sie ihre Interessenbekundungen einreichen. Weitere Informationen finden Sie im Leitfaden zum Erstellen einer Interessenbekundung.

Wie lange dauert die Teilnahme an der Google Season of Docs?

Die Projektgröße variiert, aber während des Programms sind 5 bis 30 Stunden pro Woche erforderlich. Wie viel Zeit Sie dafür aufwenden, hängt jedoch von der Art des Projekts ab, das Sie mit Ihrer Organisation vereinbart haben. Bevor Sie sich festlegen, sollten Sie das Projekt bewerten und mit der Open-Source-Organisation einen Zeitplan besprechen.

Kann ich als Einzelperson einen Antrag für eine Organisation einreichen, um Dokumentationen für ein Open-Source-Projekt zu erstellen? Ich möchte eine Reihe von Blogbeiträgen, Videos oder anderen Materialien zur Verwendung eines Open-Source-Projekts oder -Tools erstellen, bin aber weder Teil des Projekts noch ein Mitwirkender.

Nein. Sie sollten nur dann einen Vorschlag einreichen, wenn Sie im Namen des Open-Source-Projekts Gelder erhalten können. Wenn Sie an einem Projekt teilnehmen möchten, wenden Sie sich an das Projekt und arbeiten Sie gemeinsam an einem Antragsvorschlag.

Ich bin Student. Kann ich an der Google Season of Docs teilnehmen? Lerne ich bei Google Season of Docs, technische Dokumentationen zu verfassen?

Studierende können mit zugelassenen Organisationen zusammenarbeiten, aber Google Season of Docs soll keine technischen Schreibfähigkeiten vermitteln. Von den teilnehmenden technischen Redakteuren wird erwartet, dass sie über professionelle Fähigkeiten im technischen Schreiben oder eine entsprechende relevante Berufserfahrung verfügen. Studierende, die teilnehmen möchten, sollten bei der Bewerbung ihre relevanten Erfahrungen im Schreiben und Bearbeiten hervorheben.

Kann ich sowohl als Technischer Redakteur an Google Season of Docs als auch als Student an Google Summer of Code teilnehmen?

Wir raten neuen Mitwirkenden oder Studenten, die für Google Summer of Code angenommen wurden, davon ab, sich als technischer Redakteur für Google Season of Docs zu bewerben.

Google Season of Docs richtet sich nicht an Anfänger, sondern an Personen, die bereits gute bis sehr gute Fähigkeiten und Erfahrung im technischen Schreiben haben. Technische Redakteure in Google Season of Docs erhalten keine Mentoren. Stattdessen müssen sie selbstorganisiert und motiviert sein, einen Plan für die Umsetzung des Projekts der Organisation zu entwickeln, wobei sie nur wenig Unterstützung von den Administratoren der Organisation und anderen Community-Mitgliedern erhalten.

Wie kann ich mich als Technischer Redakteur an die Google-Programmadministratoren von Google Season of Docs wenden, wenn ich weitere Fragen oder Bedenken habe?

Sie können sich per E-Mail an die Google Season of Docs-Administratoren wenden: season-of-docs@google.com.

Kann ein Unternehmen oder eine Beratungsfirma für technisches Schreiben an der Google Season of Docs teilnehmen?

Ja, eine Organisation kann ein Unternehmen beauftragen, die im Angebot beschriebenen Arbeiten auszuführen.

Wie kann ich Google Season of Docs in meinem Lebenslauf erwähnen?

Geben Sie es wie jede andere freiberufliche Tätigkeit an: „Im Rahmen des Google Season of Docs-Programms als Technischer Redakteur für [Name des Projekts] gearbeitet.“

Erhalte ich ein Abschlusszertifikat für die Teilnahme an der Google Season of Docs?

Google Season of Docs kann technischen Redakteuren keine Zertifikate oder Bestätigungen der Projektteilnahme senden.

Für Open-Source-Organisationsadministratoren

Welche Voraussetzungen müssen Open-Source-Organisationen erfüllen?

Um als Organisation teilnehmen zu können, müssen Sie eine Gruppe sein, die ein aktives kostenloses oder Open-Source-Softwareprojekt betreibt, z. B. BRL-CAD. Das Projekt muss keine rechtsfähigen Rechtssubjekte sein. Organisationen müssen bereits Software gemäß einer von der Open Source Initiative genehmigten Lizenz entwickelt und veröffentlicht haben und mindestens zwei Mitwirkende haben, die als Administratoren der Organisation für das gesamte Google Season of Docs-Programm fungieren, um am Programm teilnehmen zu können.

Weitere Informationen zu den Teilnahmevoraussetzungen finden Sie in den Programmregeln und den Sanktionsprogrammen und Länderinformationen des US-Finanzministeriums.

Ist „Organisation“ mit einem Open-Source-Projekt gleichzusetzen?

Eine Organisation kann ein oder mehrere Open-Source-Projekte haben. Einige Organisationen, z. B. Stiftungen, haben möglicherweise mehrere untergeordnete Organisationen, die jeweils ein oder mehrere Open-Source-Projekte haben. Wenn Ihre Organisation unabhängige Unterorganisationen hat, reichen Sie für jede Unterorganisation separate Anträge und Vorschläge ein.

Kann eine Organisation mehr als einen Antrag einreichen?

Nein. Reichen Sie nur einen Antrag pro Organisation ein. Wenn Ihre Organisation untergeordnete Organisationen hat (z. B. eine Stiftung mit vielen einzelnen Open-Source-Projekten), sollte jedes Projekt einen eigenen Antrag einreichen, auch wenn die Fördergelder von der Dachorganisation verwaltet werden.

Kann eine Gruppe von Open-Source-Projekten gemeinsam einen Vorschlag einreichen, um an einem einzigen Dokumentationsprojekt zu arbeiten?

Eine Organisation sollte den Antrag einreichen und für die Koordination der Arbeit und Unterstützung durch andere teilnehmende Projekte verantwortlich sein. (Wenn beispielsweise eine Gruppe kleiner Open-Source-Projekte, die alle Plug-ins für ein größeres Projekt sind, an einem gemeinsamen Leitfaden zum Erstellen von Plug-ins arbeiten möchte, sollte eine Organisation ausgewählt werden, die das Projekt leitet.)

Wie erhält meine Organisation die Zahlungen?

Damit deine Organisation Geld erhalten kann, benötigt sie ein Open Collective-Konto.

Erhalten Organisationen eine Vergütung für die Teilnahme an der Google Season of Docs?

Organisationen können im Rahmen ihrer Projektbudgets Mittel für Verwaltung, Mentoring oder die Überprüfung von Arbeiten einplanen.

Übernimmt Google die Gebühren für die Zahlungsabwicklung?

Die Gebühren für die Zahlungsabwicklung werden nicht von Google übernommen, da sie je nach Zahlungsmethode variieren. Google übernimmt jedoch die Plattformgebühr von Open Collective. Wenn du Open Collective als deinen Finanzhost verwendest, wird auch diese Gebühr übernommen. Weitere Informationen finden Sie im Leitfaden zum Erhalt von Zuschüssen.

Wie sollte meine Organisation die Kosten für einen technischen Redakteur kalkulieren?

Wir empfehlen, sich die Gehaltsumfrage von Write the Docs anzusehen und Stundensätze zu berechnen. Sie können auch der Write The Docs-Slack-Gruppe beitreten und im Kanal #season-of-docs nach interessierten technischen Redakteuren fragen, die ein Angebot abgeben möchten.

Kann meine Organisation den Google Season of Docs-Zuschuss verwenden, um einen aktuellen Mitwirkenden zu bezahlen?

Ja. Projektvorschläge müssen jedoch auf neue Arbeiten (einschließlich Wartungsarbeiten, Überarbeitungen oder Upgrades vorhandener Dokumentationen) beruhen. Sie können keinen Zuschuss beantragen, der für bereits abgeschlossene Arbeiten verwendet werden soll.

Kann meine Organisation mit technischen Redakteuren in Ausbildung zusammenarbeiten?

Sie können technische Redakteure aus der Studentenschaft mit der Arbeit an Ihrem Projekt beauftragen. Wenn Sie mit Schülern und Studenten arbeiten, sollten Sie die Teilnahme auf folgende Personen beschränken:

  • Sie sind über 18 Jahre alt.
  • Sie sind in einem Programm oder Kurs für technisches Schreiben oder technische Kommunikation eingeschrieben.
  • Sie haben nachweislich über ihr Programm oder ihren Kurs Zugang zu einer Mentorschaft für technisches Schreiben.

Kann meine Organisation mit mehr als einem technischen Redakteur zusammenarbeiten?

Ihre Organisation kann mehrere Technische Redakteure auswählen und bezahlen, aber alle Technischen Redakteure, die mit Ihrer Organisation zusammenarbeiten, müssen an dem von Ihnen vorgeschlagenen Projekt arbeiten. Die Zusammenarbeit mit mehreren technischen Redakteuren erhöht die Komplexität Ihres Projekts und erfordert mehr Zeit für die Organisation und Verwaltung.

Kann meine Organisation ein Unternehmen für technisches Schreiben beauftragen, an unserem Projekt zu arbeiten?

Ja, Ihr Unternehmen kann ein Unternehmen für technisches Schreiben beauftragen, an Ihrem Projekt zu arbeiten. Das von dir beauftragte Unternehmen muss über Open Collective bezahlt werden können.

Unser Technischer Redakteur ist vor Ende des Programms ausgestiegen. Kann unsere Organisation die verbleibenden Mittel noch erhalten?

Wir empfehlen Ihnen dringend, vor Ablauf des Programms einen neuen technischen Redakteur zu finden, der Ihr Projekt abschließt. Die Auszahlung der verbleibenden Gelder erfolgt jedoch nicht nach Abschluss des Projekts, sondern nach Abschluss der Fallstudie und der abschließenden Bewertung.

Wenn Ihr Projekt nicht abgeschlossen werden konnte, sollten Sie in Ihrer Fallstudie untersuchen, warum das der Fall war. Vielleicht haben Sie beispielsweise festgestellt, dass Ihre Dokumentationstools sehr kompliziert sind und das Onboarding eines technischen Redakteurs erschweren, oder dass Ihr Projekt das Testen und Aktualisieren von Anleitungen erfordert und umfangreiche Programmierkenntnisse voraussetzt. Was würden Sie aufgrund Ihrer Erfahrung anderen Projekten empfehlen? Fügen Sie diese Informationen in Ihre Fallstudie ein.

Kann ein Antrag einer Organisation vor dem Einreichtermin geprüft werden?

Leider kann Google Season of Docs kein Feedback zum Antrag der Organisation geben.

Wie sollten Organisationen den Umfang ihrer Projektvorschläge festlegen?

Versuchen Sie, bei der Entwicklung von Projektideen die kleinsten Projekte zu finden, die für die Organisation einen Mehrwert bieten, aber bei Bedarf erweitert werden können. Je kleiner, desto besser. Wir empfehlen, beim Erstellen Ihres Projektvorschlags kleinere, detailliertere Projekte zu wählen, anstatt größere Projekte, die weniger spezifisch sind. Wenn Ihr Projekt viel Fachwissen erfordert, sollten Sie auch Projekte nennen, an denen jemand ohne diesen Hintergrund arbeiten könnte.

Kann ich als Administrator einer Organisation an Google Season of Docs und als Mentor an Google Summer of Code teilnehmen?

Ja. Google Season of Docs und Google Summer of Code sind separate Programme. Wenn du die Zeit hast, an beiden Programmen teilzunehmen, ist das in Ordnung.

Unsere Organisation hat bereits an früheren Google Season of Docs-Programmen teilgenommen. Kann sich unsere Organisation noch einmal bewerben?

Ja. Organisationen, die bereits an früheren Google Season of Docs-Programmen teilgenommen haben, können sich noch einmal bewerben.

Archivierte Daten

Wie entferne ich meine Informationen aus dem Google Season of Docs-Archiv?

Wenden Sie sich an uns, um Ihre Daten entfernen zu lassen.