Häufig gestellte Fragen

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

Allgemein

Ist „Season of Docs“ ein Rekrutierungsprogramm?

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

Gilt „Season of Docs“ als Praktikum, als Job oder in irgendeiner Form der Beschäftigung?

Nein. Die Staffel von Google Docs ist eine Aktivität, die der technische Redakteur als unabhängiger technischer Redakteur ausführt und für den er ein Gehalt erhält. Technische Autoren können den Erhalt des Stipendiums widerrufen.

Warum sollte ich an „Season of Docs“ teilnehmen?

Das Ziel von „Season of Docs“ ist die Förderung der Zusammenarbeit zwischen Open-Source-Organisationen und technischen Redakteuren. Wir gehen davon aus, dass dieses Programm:

  • Geben Sie technischen Redakteuren die Möglichkeit, Erfahrungen mit Beiträgen zu Open-Source-Projekten zu sammeln und mehr über Open-Source-Code zu erfahren.
  • Geben Sie Open-Source-Projekten die Möglichkeit, die Community für technische Texte einzubeziehen und damit die Open-Source-Dokumentation zu verbessern.
  • Auf Open-Source-Dokumente und technische Texte sensibilisieren.

Vorteile für Open-Source-Organisationen:

  • Erfahrung in der Zusammenarbeit mit einem technischen Redakteur.
  • Verbesserte Dokumente
  • Die Möglichkeit einer kontinuierlichen Zusammenarbeit mit technischen Redakteuren ist auch nach Ende der Google Docs-Saison möglich.
  • Verbesserte Prozesse zur Dokumentation von Projekten.
  • In der Community des technischen Schreibens wurde das Bewusstsein für Open-Source-Dokumente gestärkt.

Vorteile für technische Redakteure:

  • Erfahrung mit der Mitarbeit an einem Open-Source-Projekt
  • Erfahrung in der Arbeit mit entwicklerorientierten Dokumenten und mit Code
  • Anerkennung und Anerkennung für die geleistete Arbeit.
  • Etwas, das Sie Ihrem Lebenslauf hinzufügen können.
  • Die Möglichkeit einer kontinuierlichen Zusammenarbeit mit dem Open-Source-Projekt
  • Ein wachsendes Bewusstsein für den Mehrwert, den technische Redakteure bringen können, ist in Open-Source-Communitys gestiegen.

Welche Arten von Projekten können technische Redakteure angehen?

Hier einige Vorschläge:

  • Erstellen Sie auf einer Plattform eine Dokumentationswebsite, die vom technischen Autor und Open-Source-Mentor ausgewählt wird, und veröffentlichen Sie erste grundlegende 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. Die Open-Source-Organisation hat die Aufgabe, Projektideen zu veröffentlichen und einen Projektvorschlag von einem technischen Redakteur auszuwählen. Wenn ein Video die Anforderungen der Open-Source-Organisation erfüllt, können Sie es als „Season of Docs“-Projekt einreichen, sofern es sich um ein technisches Lehrvideo handelt. Achten Sie darauf, dass die Videoanforderungen gut abgegrenzt sind, und beachten Sie, dass die Produktion eines Videos in hoher Qualität Zeit und Ressourcen in Anspruch nimmt.

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

Nein. Wir hoffen zwar, dass die gesamte Dokumentation und der Code aus diesem Programm ein schönes Zuhause finden, aber wir verlangen, dass Organisationen die Dokumentation oder den Code der technischen Redakteure nicht 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.

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.

Kann ich an der Season of Docs sowohl als Mentor als auch als technischer Redakteur teilnehmen?

Nein. Wir möchten sicherstellen, dass jedes Projekt und jede technische Redakteurin ausreichend Aufmerksamkeit erhält, und wir sind der Meinung, dass dies zu einer schlechten Erfahrung für die beteiligten Personen führen könnte. Bitte wählen Sie aus, ob die Teilnahme als Mentor oder technischer Redakteur für Sie attraktiver ist, und planen Sie, sich entsprechend zu bewerben.

Gibt es Statistiken, die Sie zur Google Docs-Saison 2019 veröffentlichen können?

Ja, die Ergebnisse der Google Docs-Saison 2019 können Sie sich hier ansehen.

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

Ja. Technische Autoren und Mentoren bei erfolgreich abgeschlossenen Projekten erhalten ein T-Shirt mit dem Titel „Season of Docs“.

Wann kommt mein T-Shirt an?

Wir gehen davon aus, dass Sie Ihr T-Shirt Anfang 2021 erhalten. Google hat einen Anbieter mit der Produktion der T-Shirts und der Logistik für den weltweiten Versand beauftragt. Google-Programmadministratoren senden dir kurz nach Bekanntgabe der Projektergebnisse per E-Mail einen einmaligen Zugriffscode, mit dem du deine T-Shirt-Größe bzw. deine T-Shirt-Größe auswählen und deine Versanddetails eingeben kannst. Die Herstellung und der Versand der T-Shirts dauern in der Regel einige Wochen.

Ich habe weitere Fragen. Was kann ich tun?

Weitere Informationen finden Sie im Leitfaden für technische Autoren, im Leitfaden für Mentoren und im Leitfaden für Organisationsadministratoren.

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 Slack oder über die Diskussionsliste diskutieren. Weitere Informationen finden Sie unter Diskussionskanäle und Kontakt.

Für technische Redakteure

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

Die Bewerbungsphase für technische Redakteure dauert vom 9. Juni 2020 bis zum 9. Juli 2020. Weitere Informationen finden Sie im Programmzeitplan und im Leitfaden für technische Autoren.

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. Das Ziel 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 die Organisation nutzt, erkunden und experimentieren Sie mit der relevanten Sprache und dem entsprechenden Framework. 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“ mitzuarbeiten?

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.

Kann ich mehrere Projektvorschläge einreichen?

Ja, es wird jedoch nur ein Projektvorschlag pro technischem Redakteur angenommen. Weitere Informationen finden Sie in der Anleitung zum Erstellen Ihrer Anwendung.

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

Ja, aber Sie sollten in Ihrem Angebot Ihre vorherige Beziehung zu dem Projekt angeben.

Kann eine Gruppe gemeinsam ein Angebot einreichen, um an einem einzigen Projekt zu arbeiten?

Nein, an einem bestimmten Projekt darf nur eine Einzelperson arbeiten.

Kann ich mich direkt an die Mentoringorganisationen wenden, bevor ich einen Vorschlag für „Season of Docs“ einreiche?

Ja, du kannst direkt mit der Open-Source-Organisation, mit der du zusammenarbeiten möchtest, kommunizieren, bevor du deine Bewerbung für „Season of Docs“ einreichst. Die Open-Source-Mentoren können Ihnen helfen, Ihre Projektidee zu verfeinern.

Welche Teilnahmevoraussetzungen gelten für die Teilnahme?

  • Sie müssen mindestens 18 Jahre alt sein, wenn Sie sich registrieren.
  • Sie müssen berechtigt sein, in dem Land zu arbeiten, in dem Sie während des Programms leben.
  • Sie müssen in einem Land leben, das derzeit nicht gegen ein Embargo der USA verstößt. Weitere Informationen findest du in den Programmregeln und den Sanktionsprogrammen und Länderinformationen des US-Finanzministeriums.

Werden bei den Teilnahmevoraussetzungen für mich Ausnahmen gemacht?

Nein. Wir können keine Ausnahmen machen, wenn Sie die Teilnahmevoraussetzungen nicht erfüllen, unabhängig davon, wie talentiert oder interessiert Sie sind. Eine Ausnahme für Sie zu machen, wäre nicht fair gegenüber den anderen technischen Redakteuren, die die Teilnahme an „Season of Docs“ beantragen.

Welche Formulare muss ich einreichen?

Berechtigte Teilnehmer müssen entsprechende Steuerformulare einreichen.

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 Sie einen Projektvorschlag einreichen, können Sie Ihre Erfahrungen und/oder Schulungen technisch beschreiben. Sie sollten Nachweise vorlegen können, die Ihr Interesse an der technischen oder Open-Source-Dokumentation belegen, einschließlich Beispielen für von Ihnen verfasste Dokumentation. Das Programm "Season of Docs" zielt auf eine Partnerschaft mit erfahrenen oder in Schulungen beschäftigten technischen Redakteuren mit Open-Source-Mentoren ab, damit beide voneinander lernen können. Die Open-Source-Organisation sucht nach technischen Redakteuren mit der entsprechenden Erfahrung, um den erfolgreichen Abschluss ihrer „Season of Docs“-Projekte zu gewährleisten.

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

Ja. Google vergibt ein Stipendium an technische Redakteure, die das Programm erfolgreich abschließen. Sie können den Erhalt des Stipendiums auch deaktivieren. Weitere Informationen finden Sie im Artikel Stipendium für technische Autoren.

Erhalte ich auch dann Einnahmen, wenn die Organisation meine Dokumentation oder meinen Code nicht verwendet?

Ja, vorausgesetzt, Ihr Projekt besteht die abschließende Bewertung durch den Open-Source-Mentor. Auf die Auszahlung des Stipendiums für technische Autoren hat das Open-Source-Projekt keinen Einfluss darauf, ob die erstellte Dokumentation oder der erstellte Code verwendet wird.

Wie sieht ein guter Vorschlag für technische Redakteure aus?

Die besten Vorschläge stammen von technischen Redakteuren, die sich die Zeit nehmen, mit der jeweiligen Open-Source-Organisation zu diskutieren und ihre Ideen zu besprechen, bevor sie ihre Bewerbungen für das Programm "Season of Docs" einreichen. Weitere Informationen finden Sie in der Anleitung zum Erstellen Ihrer Anwendung.

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

Wie viel Zeit Sie dafür aufwenden müssen, hängt von der Art des Projekts ab, das Sie mit Ihrer beratenden Organisation vereinbart haben. Die Anzahl der Stunden ist bewusst flexibel, um unterschiedliche Projektarten und Arbeitsstile zu berücksichtigen. Im Durchschnitt arbeiten technische Redakteure 20 bis 30 Stunden pro Woche.

Bevor Sie Ihren Projektvorschlag einreichen, sollten Sie das Projekt bewerten und eine Zeitschätzung mit der Open-Source-Organisation besprechen. Wenn es Ihnen aufgrund anderer Verpflichtungen schwerfällt, die vereinbarte Zeit aufzuwenden, haben Sie die Möglichkeit, das Projekt in einem längeren Zeitraum abzuschließen und trotzdem das Stipendium und die Bestätigung der geleisteten Arbeit zu erhalten. Geben Sie beim Einreichen Ihres Antrags auf „Season of Docs“ die Option für ein Projekt mit langer Laufzeit an.

Ich studiere im Bereich der technischen Kommunikation, habe aber noch keine Berufserfahrung. Kann ich trotzdem teilnehmen?

Ja. Geben Sie bei der Einreichung Ihres Projektvorschlags im Abschnitt mit den Vorkenntnissen Ihre Universitäts- oder Hochschulkurse an.

Ich bin in den USA als Student mit F1-Visum zugelassen. Wie erhalte ich die Autorisierung zur Teilnahme?

Weitere Informationen erhalten Sie von der zuständigen Behörde für Studentenangelegenheiten Ihrer Bildungseinrichtung. Google kann Ihnen keine CPT- oder OPT-Autorisierung erteilen.

Alle angenommenen Teilnehmer erhalten eine Bestätigungs-E-Mail. Wir bieten keine benutzerdefinierten Buchstaben an.

Wie verwendet Season of Docs die Informationen aus meinem Antragsformular?

Die Google-Programmadministratoren leiten einige Informationen aus Ihrer Anwendung an die Administratoren der ausgewählten Open-Source-Organisation weiter, damit die Organisation Ihren Projektvorschlag bewerten kann.

Wenn Ihr Projekt in das Programm aufgenommen wird, veröffentlicht „Season of Docs“ die Projektdetails auf der Website.

Eine Beschreibung der Datennutzung findest du im Leitfaden zum Antragsformular für technische Redakteure.

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

Obwohl dies derzeit nicht gegen die Regeln verstößt, empfehlen wir dringend, dass sich Schüler/Studenten, die zur Google-Summer of Code angenommen wurden, nicht für Slots für technische Redakteure in „Season of Docs“ bewerben. Die Schüler sollten sich auf die Arbeit an Google Summer of Code konzentrieren, anstatt sich für „Season of Docs“ zu bewerben.

Für Open-Source-Mentoren und Organisationsadministratoren

Ich möchte mehr über die Teilnahme als Mentor bei „Season of Docs“ erfahren. Wo erhalte ich weitere Informationen?

Im Leitfaden für Mentoren und in den Programmrichtlinien finden Sie weitere Informationen dazu, wie Sie Mentor für die Saison werden.

Welche Teilnahmevoraussetzungen gelten für eine Mentoring-Organisation?

Um als Mentoring-Organisation teilnehmen zu können, müssen Sie eine Gruppe sein, die ein aktives kostenloses/Open-Source-Softwareprojekt wie BRL-CAD anführt. Das Projekt muss keine rechtsgültige Rechtspersönlichkeit sein. Mentoringorganisationen müssen bereits Software unter einer von der Open-Source-Initiative genehmigten Lizenz produziert und veröffentlicht haben und mindestens zwei Mitwirkende als Organisationsadministratoren und/oder Mentoren für das gesamte Season of Docs-Programm haben, 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, machen Sie dies bitte in Ihrem Antrag deutlich. Die Programmiersprache „Foo“ könnte beispielsweise für die Dokumentation für die gesamte Sprache sowie für alle Plug-ins, Bibliotheken oder Module gelten, die mit der Sprache verwendet werden.

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

Organisationen mit einwandfreiem Status erhalten am Ende des Programms ein Stipendium pro zugelassener technischer Redakteur. Dabei spielt es keine Rolle, ob das Projekt des technischen Redakteurs erfolgreich ist oder nicht. Organisationen können diese Mittel nach Belieben verwenden.

Wie vergeben die Google-Programmadministratoren Zeitblöcke für technische Schreibprojekte?

In der Saison 2020 von „Season of Docs“ sind insgesamt maximal 50 Projekte zum technischen Schreiben zulässig.

Als Richtlinie gehen wir davon aus, dass wir maximal zwei Projekte pro Organisation akzeptieren, damit es nicht zu viele Projekte gibt. Wenn bei der kostenlosen Auswahl jedoch nicht alle Slots belegt sind, können die Programmadministratoren von Google einigen Organisationen zusätzliche Slots zuweisen.

Wenn Sie Ihre Auswahl an Projekten für das technische Schreiben senden, können Sie daher mehr als zwei Projekte auswählen. Die ausgewählten Elemente müssen nach Priorität geordnet werden, wobei die höchste Priorität oben in der Liste steht.

In Ihrer Kommunikation mit den technischen Redakteuren sollten Sie deutlich machen, dass das Projekt erst angenommen wird, wenn die Google-Programmadministratoren die Liste der akzeptierten Projekte auf der Programmwebsite veröffentlichen.

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

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

Wie sollten Unternehmen ihre Projektideen planen?

Viele Projekte ändern den Umfang im Laufe der Zeit. Als beratende Person sollten Sie über Änderungen an den Projekten informiert sein und versuchen, eine schleichende Erweiterung des Projektumfangs zu minimieren und den Umfang entsprechend zu reduzieren. Versuchen Sie bei der Entwicklung von Projektideen, die kleinsten Projekte zu finden, die dem Unternehmen einen Mehrwert bieten (aber können erweitert werden, wenn es die Zeit erlaubt). Kleiner ist besser. Bei der Bewertung von Vorschlägen für technische Redakteure empfehlen wir, kleinere, detailliertere Vorschläge gegenüber größeren Projekten mit weniger genauen Vorgaben zu bevorzugen. Wenn Ihr Projekt viel Domänenwissen erfordert, versuchen Sie auch Projekte, an denen auch Personen ohne diesen Hintergrund arbeiten könnten.

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 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 als Teil Ihres Projekts einbeziehen.

Gibt es Dokumentationsvorlagen für Organisationen und technische Redakteure?

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

Kann ich sowohl als Organisationsadministrator als auch als Mentor an Season of Docs teilnehmen?

Ja. Der Administrator einer Organisation kann auch als Mentor fungieren. Sie müssen kein separates Formular für Mentoren ausfüllen. Beim Ausfüllen des Antragsformulars für die Organisation oder des alternativen Administratorformulars sollten Sie die Option in diesem Formular verwenden, um anzugeben, dass Sie auch als Mentor fungieren.

Kann ich als Organisationsadministrator oder Mentor sowohl an Season of Docs als auch an 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.

Kann ich als Organisationsadministrator oder Mentor sowohl an Season of Docs als auch an Google Code-in teilnehmen?

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

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.