FAQ

Aktuelle Phase:
Dokumentationsentwicklung. Siehe Zeitachse.

Allgemein

Ist Google Season of Docs ein Rekrutierungsprogramm?

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

Wie unterscheidet sich das aktuelle Programm von der Google-Staffel von Google Docs 2019 und 2020?

In der aktuellen Version von Google Docs hat sich im Vergleich zu den Vorjahren Folgendes geändert:

  • Technische Redakteure bewerben sich nicht mehr über Google mit Organisationen abgeglichen
  • Organisationen reichen im Rahmen ihrer Bewerbung Projektvorschläge ein, einschließlich eines Budgets und vorgeschlagenen Metriken
  • Angenommene Organisationen erhalten Zuschüsse, mit denen sie technische Redakteure bezahlen.
  • Organisationen reichen Abschlussbewertungen und Fallstudien ein

Warum wurden diese Änderungen bei Google Staffel von Docs vorgenommen?

Unser Ziel bei Google ist es, die Informationen dieser Welt zu organisieren und sie allgemein zugänglich und nutzbar zu machen. Durch die Neuausrichtung auf Google Season of Docs mit dem Ziel, mehr über effektive Dokumentationspraktiken im Bereich Open Source zu erfahren, hoffen wir, langfristig eine größere Wirkung zu erzielen.

Unsere Organisation möchte gerne an der neuen Staffel von Google Docs teilnehmen, aber wir wissen nicht, wo wir anfangen sollen!

Sieh dir unsere vollständige Liste mit Projektideen an! Sie können sich auch an die technische Community wenden (verwenden Sie den Kanal #season-of-docs in Slack für Google Docs schreiben oder in Ihren Social-Media-Kanälen), um Hilfe oder Angebote zu erhalten.

Welche Arten von Projekten können Unternehmen vorschlagen?

Hier einige Vorschläge:

  • Eine Dokumentationswebsite auf einer Plattform erstellen, die vom technischen Redakteur und der Open-Source-Organisation entschieden wird, und einen ersten Satz grundlegender Dokumente auf der Website veröffentlichen. Beispiele für Plattformen:

  • Refaktorieren Sie die vorhandene Dokumentation des Open-Source-Projekts, um die Nutzerfreundlichkeit oder die Informationsarchitektur zu verbessern.

  • Schreiben Sie eine konzeptionelle Übersicht oder eine Einführung in ein Produkt oder eine Funktion. Oft erstellt ein Team seine technische Dokumentation von Grund auf neu. Das Ergebnis sind zwar viele Details, aber das Produkt als Ganzes ist schwer zu verstehen. Ein technischer Redakteur kann dieses Problem beheben.

  • Erstellen Sie ein Tutorial für einen wichtigen Anwendungsfall.

  • Eine Reihe fokussierter Anleitungen für bestimmte Aufgaben erstellen.

  • Erstellen Sie einen Leitfaden für Beitragende mit grundlegenden Informationen zu den ersten Schritten als Mitwirkender am Open-Source-Projekt sowie Regeln zu Lizenzvereinbarungen, Prozessen für Pull-Anfragen und -Überprüfungen, Erstellung des Projekts usw.

Ist ein Video ein mögliches Projekt für die Staffel von Google Docs?

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

Ist eine Dokumentationsprüfung ein angemessenes Projekt für die Google-Staffel von Google Docs?

Ein Dokumentationsaudit ist ein großartiges Projekt für die Google-Staffel von Docs. Überlegen Sie sich gut, wie viel Dokumentation Sie bereits haben. Wenn Sie eine große Menge haben, müssen Sie möglicherweise den Umfang reduzieren (z. B. nur die Anleitungsinhalte prüfen). Wenn Sie nur wenige oder keine Dokumentation haben, können Sie das Erstellen 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 Dokumentationsprüfungen. Wir hoffen, weitere Vorlagen hinzufügen zu können, sobald sie erstellt sind.

Das Good Docs Project arbeitet an der Erstellung einiger realisierbarer Dokumentationsvorlagen für Open Source.

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

Nein. Gelegentlich werden Projekte nicht wie erwartet ausgeführt oder Anforderungen ändern sich. Wir fordern Unternehmen nicht auf, die Dokumentation oder andere Materialien zu verwenden, aber wir gehen davon aus, dass die endgültige Bewertung und Fallstudie eine Diskussion darüber enthalten, warum die Dokumentation nicht verwendet wurde und wie das Projekt entschieden hat, die Dokumentation oder andere Materialien nicht zu verwenden.

Wo finden die Google-Dateien "Saison of Docs" statt?

Die Staffel von Google Docs findet ausschließlich online statt. Sie müssen im Rahmen des Programms nicht reisen.

Wie kann ich mich über die Google-Staffel von Docs informieren?

In der Mailingliste für Ankündigungen unter season-of-docs-announce finden Sie die neuesten Updates und Ankündigungen zur Google Season of Docs. Treten Sie der Gruppe bei, um Updates per E-Mail zu erhalten.

Kann ich meinem Kalender die Zeitachse für die Google-Staffel von Google Docs hinzufügen?

Ja, Sie können sie über diesen Link hinzufügen.

Wie kann ich Google Season of Docs bekannter machen?

Sie können über das Programm twittern, Blogposts schreiben, Videos veröffentlichen oder ein Treffen oder eine Informationssitzung in Ihrer Nähe veranstalten. Wir haben einige Beispielinhalte und -ressourcen, die Sie in Ihrer Community (Organisation, Autorengruppe und andere Kontakte) verwenden können.

Wie organisiere oder veranstalte ich ein Treffen oder ein Treffen mit Informationen zur Google-Staffel von Google Docs?

Sie können ein Treffen jederzeit und an jedem Ort vereinbaren. Sehen Sie sich die Programmregeln an und verwenden Sie den Beispielinhalt.

Gibt es Statistiken, die Sie zu den Docs-Staffeln 2019 und 2020 veröffentlichen können?

Ja. Die Ergebnisse der Google-Staffel von Docs für das Jahr 2019 finden Sie hier und die Ergebnisse für das Jahr 2020 hier.

Erhalte ich ein Google-T-Shirt zur Staffel von Google Docs?

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

Ich habe weitere Fragen. Was kann ich tun?

Informationen dazu finden Sie im Administratorhandbuch für die Organisation und im Leitfaden für technische Autoren.

Wenn Sie die gesamte Dokumentation gelesen haben und immer noch keine Antwort haben, können Sie Ihre Fragen in der Diskussionsliste mit der Google-Community "Season of Docs" besprechen. Weitere Informationen zu Diskussionskanälen und zur Kontaktaufnahme finden Sie unter den jeweiligen Links.

Wie kann ich Mentor für die Season of Docs von Google sein?

Google Season of Docs hat keine offizielle Mentoringrolle. Organisationen sollten angeben, wie technische Redakteure eingestellt und unterstützt werden und wie ihre Dokumentationsbeiträge im Rahmen des Organisationsantrags geprüft und genehmigt werden. Wenn Sie im Rahmen von Google Season of Docs mit Mentoren für technische Redakteure arbeiten möchten, empfehlen wir Ihnen, mit den Administratoren Ihrer Organisation zusammenzuarbeiten, um sich freiwillig zu engagieren.

Ist die Google-Staffel von Docs wie Google Summer of Code?

Nein. Google Season of Docs ist für Menschen mit technischer Schreiberfahrung gedacht und nicht als Mentoring-Programm wie Google Summer of Code gedacht.

Für technische Redakteure

Wann können sich technische Redakteure für die Google-Staffel von Google Docs bewerben?

Für Google Staffel von Google Docs gibt es keine offizielle Anwendung für technische Redakteure. Wenn Sie als technischer Redakteur an „Google Season of Docs“ teilnehmen möchten, wenden Sie sich direkt an Open-Source-Organisationen. Folgen Sie dazu der Anleitung auf ihrer Programmseite „Google Season of Docs“. Bei Interesse können Sie sich auch in das Technical Writer Directory von Google Season of Docs eintragen. Weitere Informationen finden Sie im Leitfaden für technische Autoren.

Welche Dokumentations-Tools und -Rahmen sollte ich kennen, um an der Season of Docs teilnehmen zu können?

Welche Dokumentationstools und Frameworks Sie verwenden, hängt von der Organisation ab, mit der Sie arbeiten möchten. Das Ziel von Google Season of Docs besteht unter anderem darin, Open-Source-Projekte zu unterstützen, die technischen Redakteuren dabei helfen, mehr über die Tools und Frameworks zur Dokumentation von Open-Source-Produkten zu erfahren. Aus diesem Grund ist es in der Regel keine Voraussetzung, dass Sie umfassende Kenntnisse über bestimmte Dokumentationsplattformen haben, bevor Sie mit dem Google-Projekt "Season of Docs" beginnen.

Allerdings verwenden die meisten Open-Source-Organisationen Markdown oder eine andere Auszeichnungssprache für ihre Dokumentation. Finden Sie heraus, welche Sprache die von Ihnen gewählte Organisation verwendet, und machen Sie sich mit der Syntax vertraut. Markdown ist ein guter Anfang, da die 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 ob dies der Fall ist, welche Plattform sie verwendet. Die Plattform kann ein statischer Website-Generator wie Jekyll, Sphinx oder Hugo sein oder die Organisation kann ihre Dokumente auf Read the Docs- oder GitHub-Seiten hosten. Wenn Sie herausgefunden haben, welche Plattform das Unternehmen verwendet, erforschen und experimentieren Sie mit der relevanten Sprache und dem Framework. So können Sie schnell mit Ihrem Open-Source-Projekt beginnen und gute Tipps für ein Open-Source-Projekt Ihrer Wahl geben.

Welche Programmiersprachen sollte ich beherrschen, um an "Staffel von Google Docs"-Projekten mitzuwirken?

Je nach Art Ihres Dokumentationsprojekts müssen Sie möglicherweise mit einer Programmiersprache vertraut sein. Berücksichtigen Sie dies, wenn Sie ein Dokumentationsprojekt auswählen und vorschlagen, und wenden Sie sich bezüglich des erforderlichen Vertrautheitsgrads an die Open-Source-Organisation.

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

Ja, aber die Organisation sollte in ihrem Angebot die frühere oder laufende Beziehung des technischen Autors zum Projekt berücksichtigen.

Welche Teilnahmevoraussetzungen gelten?

Benötige ich Vorerfahrungen oder Schulungen als technische Redakteurin?

Vorkenntnisse im Bereich technisches Schreiben oder Schulungen sind vorzuziehen, aber nicht zwingend erforderlich. Wenn Sie eine Interessensbekundung für eine Organisation einreichen, können Sie Ihre Erfahrungen und/oder Ihre Schulung in schriftlicher Form beschreiben. Sie sollten in der Lage sein, einen Nachweis Ihres Interesses an der technischen oder Open-Source-Dokumentation vorzulegen, einschließlich Beispielen für von Ihnen verfasste Dokumentationen. Die Open-Source-Organisation sucht nach technischen Redakteuren, die über die erforderliche Erfahrung verfügen, um die erfolgreiche Durchführung ihrer Google-Projekte in "Season of Docs" sicherzustellen.

Werde ich für die Teilnahme an der Staffel von Google Docs bezahlt?

Ja. Google gewährt den akzeptierten Organisationen Zuschüsse für die Einstellung technischer Redakteure.

Wie sieht eine gute Interessenbekundung als technischer Redner aus?

Die besten Interessensbekundungen stammen von technischen Autoren, die sich die Zeit nehmen, ihre Ideen mit der von ihnen ausgewählten Open-Source-Organisation zu besprechen und zu besprechen, bevor sie ihre Stellungnahme einreichen. Weitere Informationen findest du im Leitfaden zum Erstellen einer Interessenbekundung.

Wie lange dauert die Teilnahme an der Google-Staffel von Google Docs?

Die Projektgröße variiert, reicht aber von 5 bis 30 Stunden pro Woche im Programm aus. Wie viel Zeit Sie 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 eine Zeitschätzung mit der Open-Source-Organisation besprechen.

Kann ich als Einzelperson eine Organisation beantragen, um Dokumentation für ein Open-Source-Projekt zu erstellen? Ich würde gerne eine Reihe von Blogposts, Videos oder anderen Materialien zur Verwendung eines Open-Source-Projekts oder -Tools erstellen, bin aber kein Mitwirkender des Projekts.

Nein. Sie sollten nur dann einen Vorschlag einreichen, wenn Sie in der Lage sind, Gelder im Namen des Open-Source-Projekts zu erhalten. Wir empfehlen Ihnen, sich an das Projekt zu wenden und einen Bewerbungsantrag zu erarbeiten.

Ich bin Student. Kann ich an der Google-Staffel von Google Docs teilnehmen? Lerne ich aus der Google-Staffel von Google Docs technische Redakteure?

Schüler und Studenten können mit akzeptierten Organisationen arbeiten. Google Season of Docs ist jedoch nicht dafür gedacht, technische Schreibfähigkeiten zu vermitteln. Wir erwarten, dass teilnehmende technische Redakteure professionelle technische Schreibfähigkeiten oder gleichwertige einschlägige Erfahrungen haben. Schüler, die mitmachen möchten, sollten ihre relevante Schreib- und Bearbeitungserfahrung hervorheben, wenn sie sich an interessierte Organisationen und Projekte wenden.

Kann ich sowohl als Technical Writer an der Google Season of Docs als auch als Student am Google Summer of Code teilnehmen?

Obwohl dies derzeit nicht gegen die Regeln verstößt, empfehlen wir Schülern dringend, die Teilnahme am Programm „Google Summer of Code“ zu akzeptieren, um sich nicht als technische Autorin für „Google Season of Docs“ zu bewerben. Die Schüler sollten sich auf die Arbeit „Google Summer of Code“ konzentrieren, anstatt sich für „Google Season of Docs“ zu bewerben.

Außerdem ist Google Season of Docs nicht für Einsteiger gedacht, sondern für Personen gedacht, die bereits gute technische Schreibfähigkeiten und -erfahrung haben. Technische Redakteure in Google Season of Docs werden nicht von Mentoren begleitet. Sie müssen stattdessen selbstorganisiert und motiviert sein, um mit minimaler Anleitung von Organisationsadministratoren und anderen Community-Mitgliedern ihren Plan für die Umsetzung des Projekts der Organisation auszuarbeiten.

Wie kann ich als technischer Redakteur die Administratoren des Google-Programms "Saison of Docs" kontaktieren, wenn ich weitere Fragen oder Bedenken habe?

Sie können die Google-Programmadministratoren "Season of Docs" per E-Mail an season-of-docs@google.com kontaktieren.

Kann ein technisches Schreibunternehmen oder eine Beratungsfirma an der Season of Docs teilnehmen?

Ja, ein Unternehmen kann ein Unternehmen mit der im Angebot genannten Arbeit beauftragen.

Wie verweise ich in meinem Lebenslauf auf die Google-Staffel von Docs?

Listen Sie es wie jede andere freiberufliche Tätigkeit auf, z.B. „Ich habe im Rahmen des Programms „Google Season of Docs“ als technischer Redakteur bei [Projektname] gearbeitet.“

Reichen Sie ein Abschlusszertifikat für Ihre Teilnahme an der "Season of Docs" von Google ein?

Wir können keine Zertifikate oder Bestätigungen der Projektteilnahme an technische Redakteure senden.

Für Administratoren von Open-Source-Organisationen

Welche Teilnahmevoraussetzungen gelten für eine Open-Source-Organisation?

Um als Organisation teilnehmen zu können, müssen Sie eine Gruppe mit einem aktiven kostenlosen/Open-Source-Softwareprojekt wie BRL-CAD sein. Das Projekt muss keine rechtsgültige Rechtspersönlichkeit sein. Organisationen müssen bereits Software unter einer von der Open-Source-Initiative genehmigten Lizenz produziert und veröffentlicht haben und mindestens zwei Beitragende als Organisationsadministratoren für das gesamte Google Season of Docs-Programm haben, um am Programm teilnehmen zu können.

Weitere Informationen finden Sie in den Teilnahmevoraussetzungen, die in den Programmregeln und den Sanktionsprogrammen und länderspezifischen Informationen des US-Finanzministeriums beschrieben sind.

Entspricht „Organisation“ einem Open-Source-Projekt?

Eine Organisation kann ein oder mehrere Open-Source-Projekte haben. Einige Organisationen, z. B. Stiftungen, haben möglicherweise mehrere Unterorganisationen mit jeweils einem oder mehreren Open-Source-Projekten. Wenn Ihre Organisation unabhängige Unterorganisationen hat, reichen Sie bitte für jede Unterorganisation separate Anwendungen und Angebote ein.

Kann eine Organisation mehrere Bewerbungen einreichen?

Nein. Bitte reichen Sie pro Organisation nur einen Antrag ein. Wenn Ihre Organisation Unterorganisationen hat (Ihre Organisation ist beispielsweise eine Stiftung mit vielen einzelnen Open-Source-Projekten), sollte jedes Projekt eine eigene Bewerbung einreichen, auch wenn die Fördermittel von der Dachorganisation bearbeitet 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 Arbeiten und den Support anderer teilnehmender Projekte verantwortlich sein. (Beispiel: Eine Gruppe von kleinen Open-Source-Projekten, die alle Plug-ins für ein größeres Projekt sind und an einer gemeinsamen Anleitung zum Erstellen von Plug-ins arbeiten möchten, sollte eine Organisation auswählen, die das Projekt leitet.)

Wie erhält meine Organisation die Mittel?

Ihre Organisation muss ein Open Collective-Konto haben, um Zahlungen erhalten zu können.

Erhalten Organisationen Geld für die Teilnahme an der "Staffel von Google Docs"?

Organisationen können im Rahmen ihres Projektbudgets Finanzmittel für die Verwaltung, das Mentoring oder die Überprüfung von Arbeiten umfassen.

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

Die Bearbeitungsgebühren werden nicht von Google übernommen, da sie je nach Zahlungsmethode variieren. Google übernimmt jedoch die Gebühr für die Open Collective-Plattform. Wenn Sie Open Collective als steuerpflichtigen Host nutzen, wird diese Gebühr ebenfalls übernommen. Weitere Informationen finden Sie im Leitfaden zum Erhalt von Zuschüssen.

Wie sollte mein Unternehmen die Kosten für technische Redakteure festlegen?

Wir empfehlen Ihnen, sich das Dokument zur Gehaltsumfrage in Google Docs anzusehen und die Stundensätze zu berechnen. Sie können auch dem Slack schreiben: Google Docs schreiben beitreten und im Kanal #season-of-docs nach interessierten technischen Autoren fragen, ob sie Gebote abgeben können.

Kann meine Organisation den Zuschuss für die Google-Staffel von Google Docs für die Zahlung eines aktuellen Beitragenden verwenden?

Ja. Projektvorschläge müssen sich jedoch auf neue Arbeiten beziehen (einschließlich Wartungsarbeiten, Überarbeitungen oder Upgrades einer vorhandenen Dokumentation). Es ist nicht möglich, eine Förderung zur Bezahlung bereits abgeschlossener Arbeiten zu beantragen.

Kann meine Organisation mit studentischen Autoren zusammenarbeiten?

Sie haben die Möglichkeit, dass Lernende technische Redakteure haben, um an Ihrem Projekt zu arbeiten. Wenn Sie sich für die Zusammenarbeit mit Studenten entscheiden, empfehlen wir Ihnen dringend, die Teilnahme auf Personen zu beschränken, die:

  • über 18 Jahre alt sind.
  • für ein Programm für technisches Schreiben oder für die technische Kommunikation angemeldet sind.
  • Nachweisbar Zugang zu technischem Mentoring über das Programm oder den Kurs haben

Kann meine Organisation mit mehr als einem technischen Redakteur zusammenarbeiten?

Ihr Unternehmen kann mehrere technische Redakteure auswählen und dafür 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 macht Ihr Projekt komplexer und erfordert mehr Freiwilligen- und Verwaltungszeit.

Kann meine Organisation eine Firma für technisches Schreiben mit unserem Projekt beauftragen?

Ja, deine Organisation kann eine Firma für technisches Schreiben mit der Arbeit an deinem Projekt beauftragen. Stelle sicher, dass das von dir beauftragte Unternehmen über Open Collective bezahlt werden kann.

Unsere technische Redakteurin hat vor Ende des Programms die Teilnahme beendet. Haben wir noch Anspruch auf das Restguthaben?

Wir empfehlen Ihnen dringend, eine neue technische Fachkraft zu finden, die Ihr Projekt noch vor Programmende abschließen kann. Die Auszahlung der verbleibenden Finanzmittel basiert jedoch nicht auf dem Abschluss des Projekts, sondern auf dem Abschluss der Fallstudie und der abschließenden Bewertung.

Wenn Ihr Projekt nicht abgeschlossen werden konnte, erwarten wir, dass Ihre Fallstudie den Grund dafür herausstellt. Vielleicht haben Sie festgestellt, dass Ihre Dokumentationstools sehr kompliziert sind und das Onboarding eines technischen Redakteurs behindert haben, oder dass Ihr Projekt Anleitungen umfasste das Testen und Aktualisieren von Anleitungen umfasste und umfassende Programmiererfahrung erforderte. Was würden Sie basierend auf Ihrer Erfahrung anderen Projekten empfehlen? Nehmen Sie diese Informationen in Ihre Fallstudie auf.

Kann ein Antrag einer Organisation vor dem Einreichungstermin überprüft werden?

Leider können wir Ihnen kein Feedback zum Antrag auf Organisation geben.

Welchen Umfang sollten Unternehmen bei ihren Projektvorschlägen festlegen?

Versuchen Sie bei der Entwicklung von Projektideen, die kleinsten Projekte zu finden, die einen Mehrwert für das Unternehmen schaffen (aber können erweitert werden, wenn es Zeit ist). Je kleiner, desto besser. Bei der Erstellung Ihres Projektvorschlags empfehlen wir, sich an kleineren, detaillierteren Projekten statt an größeren Projekten zu halten, die weniger detailliert sind. Wenn Ihr Projekt viel Domänenwissen erfordert, versuchen Sie, auch Projekte aufzunehmen, an denen jemand ohne diesen Hintergrund arbeiten könnte.

Kann ich als Organisationsadministrator 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 Sie die nötige Kapazität haben, um an beiden Programmen teilzunehmen, ist das in Ordnung.

Unsere Organisation hat an früheren Google Season of Docs-Programmen teilgenommen. Können wir uns noch einmal bewerben?

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

Archivierte Daten

Wie entferne ich meine Informationen aus dem Archiv der Google-Staffel von Google Docs?

Kontaktiere uns, um deine Daten entfernen zu lassen.