Administratorhandbuch für Organisationen

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

Dieser Leitfaden richtet sich an Administratoren von Organisationen, die sich für das Google Season of Docs-Programm bewerben oder daran teilnehmen.

Sollte Ihre Organisation am Google Season of Docs-Programm teilnehmen?

Anhand dieser Fragen können Sie herausfinden, ob Ihr Open-Source-Projekt oder Ihre Organisation an der Google Season of Docs teilnehmen sollte.

Trifft Folgendes auf Ihre Organisation oder Ihr Projekt zu?

  • Glauben Sie, dass neue oder aktualisierte Dokumentationen dazu beitragen würden, ein Ziel zu erreichen oder ein Problem in Ihrem Projekt oder Ihrer Community zu lösen?
  • Haben Sie eine erste Vorstellung oder Hypothese dazu, wie Sie den Erfolg Ihres Dokumentationsprojekts messen würden?
  • Gibt es Communitymitglieder, die bereit sind, bei der Rekrutierung, Bewertung und Einarbeitung eines technischen Redakteurs zu helfen und während des Projekts (6–8 Monate, einschließlich der Bewerbungsfrist) Fragen zu beantworten und andere Unterstützung zu leisten?
  • Haben Sie ein Communitymitglied, das als Administrator der Organisation fungieren und die Erstellung der Bewerbung koordinieren, Fragen der Programmadministratoren beantworten und monatliche Bewertungen sowie die abschließende Bewertung und Fallstudie einreichen kann? Der Administrator der Organisation sollte auch bereit sein, nach Abschluss des Google Season of Docs-Programms an Folgeumfragen teilzunehmen.

Außerdem muss deine Organisation die Teilnahmevoraussetzungen erfüllen und in der Lage sein, ein Open Collective-Konto zu erstellen.

Antragsverfahren für Organisationen

Der Bewerbungsprozess für Organisationen besteht aus zwei Phasen: der explorativen Phase und der Bewerbungsphase.

Explorative Datenanalyse

Die Bewerbungsfrist für Google Season of Docs beginnt zwar erst am 22. Februar 2024, wir empfehlen Organisationen jedoch dringend, sich die Zeit zu nehmen, die Schritte in der explorativen Phase abzuschließen, bevor sie ihre Bewerbung einreichen.

  • Erstellen Sie eine Seite für Projektvorschläge. Die Vorschlagsseite enthält eine Liste der wichtigsten Anforderungen, Ziele oder Probleme, mögliche Dokumentationslösungen und mögliche Messwerte. Diese Seite sollte öffentlich sein und Beiträge und Diskussionen der Community zulassen. Geben Sie Informationen für technische Redakteure an, die teilnehmen möchten: Wo können sie Fragen stellen, ihr Interesse bekunden oder mehr über Ihr Projekt erfahren? Wir empfehlen, eine E-Mail-Adresse hinzuzufügen, über die Sie Ihre Open-Source-Organisation bezüglich Google Season of Docs kontaktieren können. Wir raten jedoch dringend davon ab, eine private E-Mail-Adresse als E-Mail-Adresse für die Kontaktaufnahme mit Ihrer Open-Source-Organisation zu verwenden. Beispiele finden Sie in der Liste mit Projektideen.
  • Machen Sie Ihre Vorschlagsseite in Ihren Community-Kanälen bekannt und fügen Sie Ihre Organisation der Liste der interessierten Organisationen im GitHub-Repository von Google Season of Docs hinzu. Sie können Ihren Link auch im Channel #season-of-docs im Write The Docs Slack teilen. Die Werbe- und Presseseite enthält Logos und andere Inhalte, die Sie verwenden können, wenn Sie über die Google Season of Docs sprechen.
  • Überlegen Sie bei jeder Dokumentationsidee, welche Erfahrung und welche Qualifikationen ein technischer Redakteur für eine erfolgreiche Zusammenarbeit mit Ihrer Community und Organisation haben sollte. Welche Fähigkeiten könnte Ihre Community einem technischen Redakteur bei der Entwicklung helfen (z. B. mit GitHub oder Ihrer Docs-Toolchain)? Weitere Informationen finden Sie im Leitfaden für die Zusammenarbeit mit technischen Redakteuren.
  • Bitten Sie um Freiwillige, die Fragen von interessierten technischen Autoren beantworten.
  • Sehen Sie sich die eingereichten Interessenbekundungen von technischen Redakteuren an, die an Ihrem Projekt arbeiten möchten.

Bewerbungsphase

  • Wählen Sie die vielversprechendste Idee auf Ihrer Vorschlagsseite aus. Jede Organisation darf nur einen Vorschlag einreichen. Beachten Sie Folgendes:
    • Welche Idee hat das größte Interesse bei technischen Redakteuren geweckt?
    • Welche Idee hilft Ihnen, das größte Problem Ihres Projekts zu lösen? Es ist besser, eine riskantere Idee zu wählen, die eine größere Wirkung hat, als eine Idee für ein Dokumentationsprojekt, das 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 Zeit, daran teilzunehmen?

  • Erstellen Sie Ihr Angebot mithilfe der Vorlage für Angebote. Achten Sie darauf, Folgendes zu verstehen und anzugeben:

    • Das Problem, das Sie angehen möchten
    • Den Umfang der Dokumentation, die Sie verbessern oder erstellen möchten
    • Wie Sie den Erfolg Ihrer Dokumentation messen

    Ihr Vorschlag muss auch ein Budget enthalten. Unvollständige Vorschläge können nicht berücksichtigt werden.

  • Reichen Sie das Antragsformular bis zum 2. April 2024 um 18:00 Uhr (UTC) ein. Die ausgewählten Vorschläge werden am 10. April 2024 bekannt gegeben.

Projektentwicklung und -berichte

Organisationsadministratoren sollten ihre Aufgaben in jeder Phase des Programms kennen.

Projekt-Kickoff

  • Wenn Ihre Organisation bereits einen technischen Redakteur oder mehrere technische Redakteure für Ihr Projekt ausgewählt hat, vereinbaren Sie ein Kick-off-Meeting mit dem technischen Redakteur. Sie sollten mit Ihrem technischen Redakteur zusammenarbeiten, um einen Zeitplan für die Arbeit und regelmäßige Besprechungen zu erstellen.
  • Wenn Sie mehrere Interessenbekundungen von interessierten technischen Redakteuren erhalten haben, machen Sie eine öffentliche Bekanntmachung Ihrer Auswahl oder informieren Sie die Bewerber anderweitig über Ihre Entscheidung.

Förderzahlungen

  • Google Season of Docs überweist ab dem 11. Juni 2024 40% der Fördergelder auf das Open Collective-Konto der jeweiligen Organisation, nachdem sie einen technischen Redakteur eingestellt hat. Wir empfehlen Unternehmen, einen Zahlungsplan mit technischen Redakteuren anhand von Projektmeilensteinen zu erstellen, einschließlich einer Zahlung zu Beginn des Projekts.
  • Die verbleibenden 60% werden ab dem 13. Dezember 2024 auf die Open Collective-Konten von Organisationen eingezahlt, die ihre endgültigen Bewertungen und Fallstudien abschließen und einreichen. Alle erfolgreichen Projekte erhalten ab dem 13. Dezember 2024 die endgültige Zahlung.
  • Weitere Informationen zum Erstellen eines Open Collective-Kontos findest du im Leitfaden für Zahlungen.

Projektstatusberichte

  • Administratoren von Organisationen sollten die monatlichen Statusberichte innerhalb einer Woche nach Erhalt des Links zum Formular für Statusberichte ausfüllen. Der Link wird per E-Mail gesendet. Prüfen Sie daher auch Ihren Spamordner, falls Sie ihn nicht finden.

Endgültige Projektbewertung und Fallstudie

Organisationen müssen sowohl die abschließende Projektbewertung als auch die Fallstudie vor dem 10. Dezember 2024 um 18:00 Uhr (UTC) einreichen, um die verbleibenden Zuschussgelder zu erhalten.

Abschlussbewertung

Die Formulare für die abschließende Bewertung und die Fallstudie sind für Administratoren von Organisationen mindestens einen Monat vor dem 10. Dezember 2024 um 18:00 Uhr (UTC) verfügbar.

Fallstudie

Die Fallstudie für die Google Season of Docs ist das wichtigste Ergebnis der Teilnahme Ihrer Organisation an der Google Season of Docs. Ein wöchentliches Protokoll mit Projektaktualisierungen hilft Ihnen beim Erstellen Ihrer Fallstudie. Notieren Sie für jede Woche den Projektfortschritt (einschließlich Links zu Pull-Requests, Problemen oder Unterhaltungen, sofern nützlich), was gut (oder nicht gut) gelaufen ist, was Sie gelernt haben und welche Fragen gestellt wurden.

Weitere Informationen finden Sie unter Fallstudien erstellen. Beachten Sie beim Erstellen Ihrer Fallstudie unbedingt unsere Vorlage für Fallstudien. Sie reichen Ihre Fallstudie als Link im Formular für Fallstudien ein.

Ihre Fallstudie wird auf der Website von Google Season of Docs veröffentlicht. Berücksichtigen Sie dies, wenn Sie Informationen zu Ihrem Projekt angeben.

Folgeumfragen

Akzeptierte Organisationen müssen an mindestens drei Folgeumfragen teilnehmen, um den Erfolg von Google Season of Docs-Projekten im Zeitverlauf zu verfolgen. Die Folgeumfragen sind entscheidend für unser Verständnis der Auswirkungen der Google Season of Docs.

Formulare

Formular Link Frist
Organisationsanwendung

Die Bewerbungsfrist für Organisationen ist abgelaufen. Melden Sie sich unter season-of-docs-announce für die Ankündigungs-Mailingliste an, um auf dem Laufenden zu bleiben.

 2. April 2024, 18:00 Uhr (UTC)
Zahlungsinformationen der Organisation

Phase für Zahlungsinformationen der Organisation abgeschlossen. Wenn Sie Änderungen an den Zahlungsinformationen Ihrer Organisation vornehmen möchten, wenden Sie sich bitte an die Administratoren von Season of Docs.

 22. Mai 2024, 18:00 Uhr (UTC)
Nachweis der Einstellung eines technischen Redakteurs

Die Phase der Einstellung von technischen Redakteuren ist abgeschlossen.

 22. Mai 2024, 18:00 Uhr (UTC)
Monatliche Bewertungen

Die monatliche Bewertungsphase ist abgeschlossen.

 Zeitachse ansehen
Einreichen einer Fallstudie

Die Fallstudienphase ist abgeschlossen.

 10. Dezember 2024 um 18:00 Uhr UTC
Abschlussbewertung des Programms

Die Projektbewertungsphase ist abgeschlossen.

 10. Dezember 2024 um 18:00 Uhr UTC
Folgeumfragen

Das Formular ist während der Phase der Folgeumfragen (1. Mai 2025) verfügbar.

 Zeitachse ansehen