Häufig gestellte Fragen

Aktuelle Phase:
Ankündigung der Ergebnisse Zeitplan.

Allgemein

Ist „Season of Docs“ ein Rekrutierungsprogramm?

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

Wie unterscheidet sich das aktuelle Programm von der Saison 2019 und 2020?

Die aktuelle Version der Google Docs-Saison hat sich im Vergleich zu den Vorjahren deutlich geändert. Hier einige Beispiele:

  • Technische Redakteure bewerben sich nicht mehr über Google für den Abgleich mit Organisationen.
  • 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 abschließende Bewertungen und Fallstudien ein

Warum wurden diese Änderungen in der Staffel von Google Docs vorgenommen?

Google hat es sich zur Aufgabe gemacht, die Informationen dieser Welt zu organisieren und sie allgemein zugänglich und nutzbar zu machen. Wir hoffen, dass wir damit langfristig eine größere Wirkung erzielen.

Unsere Organisation würde gerne bei „Season of Docs“ mitmachen, 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 Schreib-Community wenden (verwenden Sie den Kanal #season-of-docs in Dokumente schreiben in Slack oder in Ihren Social-Media-Kanälen, um Hilfe oder Vorschläge zu erhalten).

Welche Arten von Projekten können Unternehmen vorschlagen?

Hier einige Vorschläge:

  • Erstellen Sie auf einer Plattform eine Dokumentationswebsite, die vom technischen Autor und der Open-Source-Organisation ausgewählt wird, und veröffentlichen Sie einen ersten Satz grundlegender Dokumente auf der Website. Beispiele für Plattformen:

  • Refaktorieren Sie die vorhandene Dokumentation des Open-Source-Projekts, um die Nutzerfreundlichkeit zu verbessern oder die Informationsarchitektur besser zugänglich zu machen.

  • Schreiben Sie eine konzeptionelle Übersicht oder 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 lässt sich nur schwer verstehen. Ein technischer Redakteur kann dieses Problem beheben.

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

  • Sie erstellen eine Reihe gezielter Anleitungen für bestimmte Aufgaben.

  • Erstellen Sie einen Leitfaden für Beitragende, der grundlegende 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. enthält.

Ist ein Video ein mögliches Projekt für „Season of Docs“?

Ja. Achten Sie darauf, dass die Videoanforderungen gut abgegrenzt sind, und beachten Sie, dass die Produktion eines qualitativ hochwertigen Videos viel Zeit und Ressourcen in Anspruch nimmt.

Ist eine Dokumentationsprüfung ein sinnvolles Projekt für Season of Docs?

Eine Dokumentationsprüfung ist ein großartiges Projekt für Season of Docs. Denken Sie daran, wie viele 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 als Teil Ihres Projekts einbeziehen.

Gibt es Dokumentationsvorlagen für Organisationen und technische Redakteure?

Season of Docs bietet ein GitHub-Repository mit einer Vorlage und einer Checkliste für die Durchführung von Dokumentationsprüfungen. Wir hoffen, weitere Vorlagen hinzufügen zu können, sobald sie erstellt wurden.

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

Sind Organisationen verpflichtet, die von technischen Redakteuren erstellten Dokumente zu 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 erwarten, dass die abschließende 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 findet die Datei „Staffel von Dokumenten“ 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 Staffel von Google Docs informieren?

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

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

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

Wie kann ich andere auf Season of Docs aufmerksam machen?

Sie können über das Programm twittern, Blogposts schreiben, Videos veröffentlichen oder ein Treffen oder eine Informationssitzung in Ihrer Region 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 eine Informationssitzung oder ein Treffen zur Staffel von Google Docs?

Sie können jederzeit einen Termin für ein Treffen vereinbaren. Sehen Sie sich die Programmregeln an und verwenden Sie den Beispielinhalt.

Gibt es irgendwelche Statistiken, die Sie zu den Saisons von Google Docs für 2019 und 2020 veröffentlichen können?

Ja. Unsere Ergebnisse für die Saison der Dokumente 2019 können Sie hier und die Ergebnisse für das Jahr 2020 einsehen.

Erhalte ich ein "Season of Docs"-T-Shirt?

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

Ich habe weitere Fragen. Was kann ich tun?

Weitere Informationen finden Sie im Leitfaden für Organisationsadministratoren 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 mit der Season of Docs-Community auf der Diskussionsliste diskutieren. Weitere Informationen finden Sie unter Diskussionskanäle und Kontakt.

Wie kann ich ein Mentor für Season of Docs sein?

Die Staffel von Google Docs hat keine formelle Rolle als Mentor. Organisationen sollten angeben, wie technische Redakteure aufgenommen und unterstützt werden und wie ihre Dokumentationsbeiträge im Rahmen des Organisationsantrags geprüft und genehmigt werden. Wenn Sie im Rahmen von „Season of Docs“ als Mentor für technische Redakteure tätig sein möchten, empfehlen wir Ihnen, mit den Administratoren Ihrer Organisation zusammenzuarbeiten.

Ist die Season of Docs wie der Google Summer of Code?

Nein. Die Season of Docs ist für Personen mit technischer Schreiberfahrung gedacht. Sie ist nicht als Mentoringprogramm wie Google Summer of Code gedacht.

Für technische Redakteure

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

Für die Staffel von Google Docs gibt es keinen offiziellen Antrag als technischer Redakteur. Wenn Sie als technischer Redakteur an „Season of Docs“ teilnehmen möchten, wenden Sie sich direkt an Open-Source-Organisationen. Folgen Sie dazu der Anleitung auf der entsprechenden Programmseite. Bei Interesse können Sie sich auch in das Season of Docs – Verzeichnis für technische Redakteure eintragen. Weitere Informationen finden Sie im Leitfaden für technische Redakteure.

Welche Dokumentationstools und -rahmen sollte ich kennen, um an "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. Ein Teil des Ziels von „Season of Docs“ ist, dass die Open-Source-Projekte technische Redakteure dabei unterstützen, mehr über die Tools und Frameworks für die Dokumentation von Open-Source-Produkten zu erfahren. Aus diesem Grund müssen Sie in der Regel keine detaillierten Kenntnisse über bestimmte Dokumentationsplattformen haben, bevor Sie mit dem 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 wenn ja, welche Plattform sie verwendet. Die Plattform kann ein statischer Websitegenerator wie Jekyll, Sphinx oder Hugo sein oder die Organisation kann ihre Dokumente auf Docs lesen oder GitHub-Seiten hosten. Wenn Sie herausgefunden haben, welche Plattform das Unternehmen nutzt, erkunden Sie die relevante Sprache und das entsprechende Framework und experimentieren Sie damit. Dies hilft Ihnen, schnell mit Ihrem Open-Source-Projekt zu beginnen, und bietet Ihnen die Möglichkeit, fundierte Ratschläge für das Open-Source-Projekt Ihrer Wahl zu geben.

Welche Programmiersprachen sollte ich beherrschen, um an „Season of 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 „Season of Docs“ weiter daran arbeiten?

Ja, aber das Unternehmen sollte die frühere oder laufende Beziehung des technischen Redakteurs zum Projekt in seinem Angebot erwähnen.

Welche Teilnahmevoraussetzungen gelten für die Teilnahme?

Benötige ich Vorkenntnisse oder eine Schulung als technischer Redakteur?

Vorkenntnisse in technischem Schreiben oder in Schulungen sind von Vorteil, aber nicht unbedingt erforderlich. Wenn du eine Interessensbekundung für eine Organisation einreichst, kannst du deine Erfahrungen und/oder deine Schulung technisch beschreiben. Sie sollten Nachweise vorlegen können, die Ihr Interesse an der technischen oder der Open-Source-Dokumentation belegen, einschließlich Beispielen für von Ihnen verfasste Dokumentation. Die Open-Source-Organisation sucht nach technischen Redakteuren, die über die erforderliche Erfahrung verfügen, um die „Season of Docs“-Projekte erfolgreich abzuwickeln.

Werde ich für die Teilnahme an „Season of Docs“ bezahlt?

Ja. Google gewährt den akzeptierten Organisationen Zuschüsse für die Beschäftigung von technischen Redakteuren.

Wie sieht eine gute Interessenbekundung für technische Redakteure 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 diskutieren und zu diskutieren, bevor sie ihre Aussagen einreichen. Weitere Informationen findest du im Leitfaden zum Erstellen einer Interessensbekundung.

Wie lange dauert die Teilnahme an der saisonalen Präsentation von Google Docs?

Die Projektgrößen variieren, reichen jedoch von 5 bis 30 Stunden pro Woche während des Programms. Wie viel Zeit Sie dafür aufwenden müssen, 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 einen Antrag auf Erstellung einer Dokumentation für ein Open-Source-Projekt einreichen? Ich würde gerne eine Reihe von Blogposts, Videos oder anderen Materialien zur Verwendung eines Open-Source-Projekts oder -Tools erstellen, bin aber kein Mitglied 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 Bewerbungsvorschlag zu erarbeiten.

Ich bin Student und bin berechtigt, an der „Season of Docs“ teilzunehmen? Lerne ich aus der Google Docs-Staffel als technische Redakteurin?

Schüler und Studenten sind berechtigt, mit akzeptierten Organisationen zu arbeiten. „Season of Docs“ ist jedoch nicht dafür gedacht, technische Schreibfähigkeiten zu vermitteln. Wir gehen davon aus, dass die teilnehmenden Redakteure über professionelle Schreibfähigkeiten oder ähnliche Erfahrungen verfügen. Lernende, die teilnehmen möchten, sollten ihre relevante Schreib- und Bearbeitungserfahrung hervorheben, wenn sie sich an interessierte Organisationen und Projekte wenden.

Kann ich als technischer Redakteur an „Season of Docs“ und als Student am Google Summer of Code teilnehmen?

Auch wenn dies derzeit nicht gegen die Regeln verstößt, empfehlen wir Schülern, die zur Google Summer of Code-Zertifizierung berechtigt sind, sich nicht als technische Redakteurin für die Staffel von Docs zu bewerben. Die Schüler sollten sich auf die Arbeit an Google Summer of Code konzentrieren, anstatt sich für „Season of Docs“ zu bewerben.

„Season of Docs“ ist außerdem nicht für Anfänger gedacht. Es richtet sich an Nutzer, die bereits über fundierte technische Fähigkeiten und Erfahrung verfügen. Technische Autoren in „Season of Docs“ werden nicht von Mentoren begleitet. Sie müssen stattdessen selbstorganisiert und motiviert sein, ihren Plan für die Bewältigung des Unternehmensprojekts mit minimaler Unterstützung durch die Organisationsadministratoren und andere Community-Mitglieder auszuarbeiten.

Wie kann ich als technischer Redakteur die Google-Programmadministratoren "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 „Season of Docs“ teilnehmen?

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

Wie verweise ich in meinem Lebenslauf auf „Season of Docs“?

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

Reichen Sie einen Abschlusszertifikat für die Teilnahme an der Saison „Season of Docs“ ein?

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

Für Open-Source-Organisationsadministratoren

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

Um als Organisation teilnehmen zu können, müssen Sie eine Gruppe sein, die ein aktives Projekt für kostenlose/Open-Source-Software wie BRL-CAD betreibt. Das Projekt muss keine gesetzeskonforme Rechtspersönlichkeit sein. Organisationen müssen bereits Software unter einer von einer Open-Source-Initiative genehmigten Lizenz produziert und veröffentlicht haben und mindestens zwei Beitragende haben, die während des gesamten Programms „Season of Docs“ als Organisationsadministratoren fungieren, um am Programm teilnehmen zu können.

Beachten Sie auch die Teilnahmevoraussetzungen, die in den Programmregeln und den Sanktionsprogrammen und Länderinformationen des US-Finanzministeriums beschrieben sind.

Ist „Organisation“ gleichbedeutend mit 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 einen separaten Antrag und ein Angebot ein.

Kann eine Organisation mehrere Bewerbungen einreichen?

Nein. Bitte reichen Sie pro Organisation nur einen Antrag ein. Wenn Ihre Organisation Unterorganisationen hat (z. B. eine Stiftung mit vielen einzelnen Open-Source-Projekten), sollte jedes Projekt einen eigenen Antrag einreichen, auch wenn die Fördermittel von der Dachorganisation übernommen werden.

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

Eine Organisation sollte die Bewerbung einreichen und für die Koordination der Arbeit und die Unterstützung anderer teilnehmender Projekte verantwortlich sein. (Beispiel: Eine Gruppe kleiner Open-Source-Projekte, die allesamt 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 für das Projekt auswählen.)

Wie erhält meine Organisation Mittel?

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

Erhalten Organisationen Geld für die Teilnahme an „Season of Docs“?

Organisationen können in ihr Projektbudget Mittel für Verwaltung, Mentoring oder Überprüfung von Arbeiten einplanen.

Übernimmt Google die Bearbeitungsgebühren?

Die Gebühren für die Zahlungsabwicklung 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 sich für Open Collective entscheiden, ist diese Gebühr ebenfalls abgedeckt. Weitere Informationen finden Sie im Leitfaden zu Zuteilungen.

Wie sollte meine Organisation die Kosten eines technischen Redakteurs im Budget festlegen?

Wir empfehlen Ihnen, sich die Gehaltsumfrage in Google Docs erstellen anzusehen und die Stundensätze zu berechnen. Sie können auch dem Slack-Team Write The Docs Slack beitreten und im Kanal #season-of-docs nach interessierten technischen Autoren fragen, ob sie ein Gebot abgeben können.

Kann meine Organisation den „Season of Docs“-Zuschuss nutzen, um einen aktuellen Beitragenden zu bezahlen?

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

Kann meine Organisation mit studentischen Autoren zusammenarbeiten?

Sie können entscheiden, ob Studierende technische Redakteure an Ihrem Projekt arbeiten lassen. Wenn Sie sich für die Zusammenarbeit mit Studenten entscheiden, empfehlen wir Ihnen dringend, die Teilnahme auf diejenigen zu beschränken, die:

  • Sie sind über 18 Jahre alt.
  • Sie sind für ein Programm für technisches Schreiben oder eine technische Kommunikation oder für einen Kurs eingeschrieben.
  • Nachweisbarer Zugang zu Mentoring für technisches Schreiben über das Programm oder den Kurs

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, dein Unternehmen kann eine Firma für technisches Schreiben mit der Arbeit an deinem Projekt beauftragen. Das Unternehmen, das du beauftragst, muss über Open Collective bezahlt werden können.

Unser technischer Redakteur hat vor dem Ende des Programms die Teilnahme am Programm beendet. Haben wir noch Anspruch auf das Restguthaben?

Wir empfehlen Ihnen dringend, einen neuen technischen Redakteur zu finden, der Ihr Projekt noch vor dem Ende des Programms abschließen kann. Die Auszahlung der verbleibenden Geldmittel 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 die Einarbeitung eines technischen Redakteurs erschwert haben, oder dass Ihr Projekt Anleitungen zum Testen und Aktualisieren von Anleitungen umfasst und umfangreiche Programmiererfahrung erfordert. Was würden Sie anderen Projekten basierend auf Ihrer Erfahrung empfehlen? Nehmen Sie diese Informationen in Ihre Fallstudie auf.

Kann ein Antrag einer Organisation vor Ablauf der Einreichungsfrist überprüft werden?

Leider können wir kein Feedback zum Antrag der 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 bei Gelegenheit erweitert werden können). Kleiner ist besser. Bei der Erstellung Ihres Projektvorschlags empfehlen wir, statt größeren Projekten kleinere, detailliertere Projekte zu verwenden. 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 Season of Docs und als Mentor am Google Summer of Code teilnehmen?

Ja. Season of Docs und Google Summer of Code sind separate Programme. Wenn Sie die Kapazitäten haben, um an beiden Programmen teilzunehmen, ist das in Ordnung.

Unsere Organisation nahm an früheren Programmen der Google Docs-Saison teil. Können wir uns noch einmal bewerben?

Ja, Organisationen, die bereits an früheren Programmen der Saison von Google Docs teilgenommen haben, können sich erneut bewerben.

Archivierte Daten

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

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