Aktuelle Phase:
Dokumentationsentwicklung. Siehe Zeitachse.
Dieser Leitfaden richtet sich an Administratoren, die sich für das Google-Programm "Season of Docs" bewerben oder daran teilnehmen.
Sollte Ihre Organisation am Google Season of Docs-Programm teilnehmen?
Die folgenden Fragen helfen Ihnen dabei, herauszufinden, ob Ihr Open-Source-Projekt oder Ihre Organisation an Google Season of Docs teilnehmen sollte.
Muss Ihre Organisation oder Ihr Projekt die folgenden Anforderungen erfüllen?
- Sind Sie der Meinung, dass neue oder aktualisierte Dokumentation dazu beitragen würde, ein Ziel zu erreichen oder ein Problem in Ihrem Projekt oder Ihrer Community zu lösen?
- Haben Sie ein erstes Verständnis dafür oder eine Hypothese dafür, wie Sie den Erfolg Ihres Dokumentationsprojekts messen würden?
- Haben Sie Community-Mitglieder, die bereit sind, bei der Rekrutierung, Bewertung und Einarbeitung eines technischen Redakteurs zu helfen, und die während des Projekts (6 bis 8 Monate einschließlich Bewerbungszeitraums) Fragen beantworten und sonstige Unterstützung anbieten können?
- Ein Community-Mitglied soll als Administrator der Organisation fungieren und die Bewerbungserstellung koordinieren, Fragen der Programmadministratoren beantworten und monatliche Bewertungen sowie die abschließende Bewertung und Fallstudie einreichen? Der Administrator der Organisation sollte auch bereit sein, nach Abschluss des Google Season of Docs-Programms Folgeumfragen zu beantworten.
Ihre Organisation sollte außerdem die Teilnahmevoraussetzungen für das Programm erfüllen und unter anderem ein Open Collective-Konto erstellen können.
Antragsverfahren für die Organisation
Erkundungsphase
Obwohl die Bewerbungen für die „Saison of Docs“ von Google am 22. Februar 2024 beginnen, empfehlen wir Organisationen dringend, sich die Zeit zu nehmen, die Schritte der Untersuchungsphase abzuschließen, bevor sie ihre Bewerbung einreichen.
- Seite für Projektvorschläge erstellen Die Angebotsseite enthält eine Liste der wichtigsten Anforderungen, Ziele oder Probleme, möglichen Dokumentationslösungen und möglicher Messwerte. Diese Seite sollte öffentlich sein und die Möglichkeit zur Diskussion und zur Diskussion der Community bieten. Stellen Sie Informationen für technische Redakteure bereit, die teilnehmen möchten. Wo sollten sie Fragen stellen, Interesse bekunden oder mehr über Ihr Projekt erfahren? Wir empfehlen, eine E-Mail-Adresse hinzuzufügen, unter der Sie Ihre Open-Source-Organisation bezüglich Google Season of Docs kontaktieren können. Wir raten jedoch dringend davon ab, eine persönliche E-Mail-Adresse als E-Mail-Adresse für die Kontaktaufnahme mit Ihrer Open-Source-Organisation zu verwenden. Beispiele finden Sie in der Liste der Projektideen.
- Machen Sie Ihre Angebotsseite in Ihren Community-Kanälen bekannt und fügen Sie Ihre Organisation der Liste der interessierten Organisationen im GitHub-Repository "Google Season of Docs" hinzu. Sie können Ihren Link auch im Kanal #season-of-docs unter Die Docs-App schreiben teilen. Die Werbe- und Presseseite enthält Logos und andere Inhalte, die Sie verwenden können, wenn Sie über Google Season of Docs sprechen.
- Überlegen Sie sich für jede Dokumentationsidee, welche Erfahrung und Qualifikationen ein technischer Redakteur benötigen würde, um erfolgreich mit Ihrer Community und Ihrer Organisation zu arbeiten. Welche Fähigkeiten könnte Ihre Community einem technischen Redakteur bei der Entwicklung unterstützen (z. B. mit GitHub oder Ihrer Toolchain)? Weitere Informationen finden Sie im Leitfaden zur Zusammenarbeit mit technischen Redakteuren.
- Bitten Sie Freiwillige, die Fragen von interessierten technischen Redakteuren zu beantworten.
- Beginnen Sie damit, alle eingereichten Interessenaussagen von technischen Redakteuren zu lesen, die an der Arbeit mit Ihrem Projekt interessiert sind.
Bewerbungsphase
- Wählen Sie auf der Angebotsseite die vielversprechendste Idee aus. Jede Organisation darf
nur ein Angebot einreichen. Beachten Sie dabei Folgendes:
- Welche Idee hat bei technischen Redakteuren das größte Interesse geweckt?
- Welche Idee hilft Ihnen, das größte Problem Ihres Projekts zu lösen? Es ist besser, eine riskantere Idee auszuwählen, die eine größere Auswirkung hätte als eine Idee für ein Dokumentationsprojekt, die mit größerer Wahrscheinlichkeit abgeschlossen wird, aber keinen wesentlichen Unterschied für Ihr Projekt macht.
- Erfordert die Idee die Beteiligung bestimmter Mitglieder Ihrer Community? Haben sie ausreichend Zeit, sich einzubringen?
Erstellen Sie Ihr Angebot mithilfe der Angebotsvorlage. Stellen Sie sicher, dass Sie Folgendes verstehen und angeben:
- Das Problem, das Sie angehen möchten
- Der Umfang der Dokumentation, die Sie verbessern oder erstellen möchten
- Wie Sie den Erfolg Ihrer Dokumentation messen
Ihr Angebot muss außerdem ein Budget enthalten. Unvollständige Angebote können nicht berücksichtigt werden.
Reichen Sie das Antragsformular bis zum 2. April 2024 um 18:00 Uhr (UTC) ein. Akzeptierte Vorschläge werden am 10. April 2024 angekündigt.
Projektentwicklung und Berichterstattung
Projekt-Kickoff
- Wenn Ihre Organisation bereits eine oder mehrere technische Redakteure für Ihr Projekt ausgewählt hat, vereinbaren Sie ein Kick-off-Meeting mit dieser Person. Sie sollten mit Ihrer Fachkraft für technische Redaktion zusammenarbeiten, um einen Zeitplan für die Arbeit und regelmäßige Kontaktaufnahmen zu erstellen.
- Wenn Sie mehrere Interessensbekundungen von interessierten technischen Redakteuren erhalten haben, geben Sie Ihre Auswahl als technischer Redner öffentlich bekannt oder informieren Sie die Bewerber auf andere Weise über Ihre Entscheidung.
Zahlungen gewähren
- Google Season of Docs wird ab dem 11. Juni 2024 40% der Fördermittel auf das Open Collective-Konto jeder Organisation einzahlen, nachdem eine technische Redaktion eingestellt wurde. Wir empfehlen Organisationen, einen Zahlungsplan mit technischen Redakteuren auf der Grundlage von Projektmeilensteinen zu erstellen, einschließlich einer Zahlung beim Projektstart.
- Die verbleibenden 60% werden den Open Collective-Konten von Organisationen gutgeschrieben, die ab dem 13. Dezember 2024 ihre endgültigen Bewertungen und Fallstudien einreichen und einreichen. Für alle erfolgreichen Projekte wird die Abschlusszahlung am 13. Dezember 2024
- Weitere Informationen zum Erstellen eines Open Collective-Kontos findest du im Zahlungsleitfaden.
Berichterstellung zum Projektstatus
- Administratoren der Organisation sollten die monatlichen Statusberichte innerhalb einer Woche nach Erhalt des Links zum Statusbericht ausfüllen. Der Link wird per E-Mail gesendet. Sehen Sie daher in Ihrem Spamordner nach, wenn Sie ihn nicht gesehen haben.
Abschließende Projektbewertung und Fallstudie
Organisationen müssen sowohl die Abschlussbewertung des Projekts als auch die Fallstudie vor dem 10. Dezember 2024 um 18:00 Uhr (UTC) abschließen und einreichen, um die verbleibenden Fördermittel zu erhalten.
Abschließende Bewertung
Das endgültige Bewertungsformular steht Organisationsadministratoren mindestens einen Monat vor dem 10. Dezember 2024 um 18:00 Uhr (UTC) zur Verfügung.
Fallstudie
Die Fallstudie zur Google-Staffel von Docs ist der wichtigste Liefergegenstand der Teilnahme Ihrer Organisation an der Google-Staffel von Google Docs. Ein wöchentliches Protokoll der Projekt- updates hilft Ihnen, Ihre Fallstudie zu erstellen. Zeichnen Sie für jede Woche den Projektfortschritt auf (einschließlich Links zu Pull-Anfragen, Problemen oder Gesprächen, falls hilfreich), was gut (oder nicht gut) gelaufen ist, was Sie gelernt haben und welche Fragen gestellt wurden.
Weitere Informationen finden Sie unter Fallstudie erstellen. Beachten Sie beim Erstellen Ihrer Fallstudie auch unsere Vorlage für Fallstudien. Sie werden Ihre Fallstudie als Link im endgültigen Bewertungsformular einreichen.
Ihre Fallstudie wird auf der Website zur Google-Staffel von Google Docs veröffentlicht. Berücksichtigen Sie dies, wenn Sie Informationen zu Ihrem Projekt hinzufügen.
Zugelassene Organisationen müssen an mindestens drei Folgeumfragen teilnehmen, um den Erfolg von Google-Projekten zur "Saison of Docs" im Laufe der Zeit zu erfassen.
Formulare
| Form | Link | Frist |
|---|---|---|
| Organisationsanwendung | Es wurden keine Bewerbungen für die Organisation mehr angenommen. Abonnieren Sie die Mailingliste unter season-of-docs-announce, um auf dem Laufenden zu bleiben. |
2. April 2024 um 18:00 Uhr (UTC) |
| Zahlungsinformationen der Organisation | 14. Mai 2024 um 18:00 Uhr (UTC) | |
| Nachweis über die Einstellung von technischen Redakteuren | 22. Mai 2024 um 18:00 Uhr (UTC) | |
| Monatliche Auswertungen | Formular während der Projektbewertungsphase verfügbar (5. Juni 2024). |
Zeitachse ansehen |
| Abschließende Projektbewertung und Fallstudie | Formular während der abschließenden Projektbewertungs- und Fallstudienphase (22. November 2024 bis 10. Dezember 2024) verfügbar. |
10. Dezember 2024, 18:00 Uhr (UTC) |
| Folgeumfragen | Formular während der Phase der Folgeumfragen (1. Mai 2025) |
Zeitachse ansehen |