Administratorhandbuch für Organisationen

Aktuelle Phase:
Ankündigung der Ergebnisse Zeitplan.

Dieser Leitfaden richtet sich an Organisationsadministratoren, die sich für das Programm "Saison von Google Docs" bewerben oder daran teilnehmen.

Sollte Ihre Organisation am Programm "Season of Docs" teilnehmen?

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

Wie sieht Ihre Organisation oder Ihr Projekt aus:

  • Sind Sie der Meinung, dass eine neue oder aktualisierte Dokumentation dabei helfen 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 Community-Mitglieder, die bei der Rekrutierung, Bewertung und Einarbeitung einer technischen Redaktion helfen, und die während des Projekts (6–8 Monate einschließlich Bewerbungszeitraum) Fragen beantworten und sonstige Unterstützung bieten können?
  • Haben Sie ein Community-Mitglied, das bereit ist, als Organisationsadministrator zu fungieren und die Erstellung der Bewerbung zu koordinieren, Fragen der Programmadministratoren zu beantworten und monatliche Bewertungen sowie die abschließende Bewertung und Fallstudie einzureichen? Der Administrator der Organisation sollte nach Abschluss des Programms "Season of Docs" auch bereit sein, Folgeumfragen zu beantworten.

Ihre Organisation sollte außerdem die Teilnahmevoraussetzungen für das Programm erfüllen und unter anderem in der Lage sein, ein Open Collective-Konto zu erstellen.

Der Bewerbungsprozess für die Organisation

Erkundungsphase

Die Bewerbungsfrist für die „Saison of Docs“-Bewerbung beginnt am 23. Februar 2022. Wir empfehlen Organisationen jedoch dringend, sich die Zeit zu nehmen, die Schritte der explorativen Datenanalyse 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öglichen Messwerten. Diese Seite sollte öffentlich sein und Beiträge und Diskussionen der Community ermöglichen. Fügen Sie Informationen für technische Redakteure hinzu, die teilnehmen möchten. Wo sollten sie Fragen stellen, Interesse bekunden oder mehr über Ihr Projekt erfahren? Wir empfehlen Ihnen, eine E-Mail-Adresse hinzuzufügen, unter der Sie Ihre Open-Source-Organisation bezüglich „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 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 "Season of Docs" hinzu. Vielleicht möchten Sie Ihren Link auch im Kanal #season-of-docs im Kanal Write The Docs Slack teilen. Die Werbe- und Presseseite enthält Logos und andere Inhalte, die Sie verwenden können, wenn Sie über „Season of Docs“ sprechen.
  • Überlegen Sie für jede Idee zur Dokumentation, welche Erfahrung und Qualifikationen ein technischer Redakteur benötigt, 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 für Dokumente)? Weitere Informationen finden Sie im Leitfaden zur Zusammenarbeit mit technischen Redakteuren.
  • Bitten Sie Freiwillige, die Fragen interessierter technischer Redakteure zu beantworten.
  • Beginnen Sie damit, alle eingereichten Interessenbekundungen von technischen Redakteuren zu überprüfen, die an der Zusammenarbeit mit Ihrem Projekt interessiert sind.

Bewerbungsphase

  • Wählen Sie auf der Seite für Vorschläge die vielversprechendste Idee aus. Jede Organisation darf nur einen Vorschlag einreichen. Beachten Sie Folgendes:
    • Welche Idee hat bei technischen Redakteuren das größte Interesse geweckt?
    • Welche Idee wird dabei helfen, das größte Problem Ihres Projekts zu lösen? Es ist besser, eine riskantere Idee zu wählen, die eine größere Auswirkung hätte als eine Idee für ein Dokumentationsprojekt, das mit größerer Wahrscheinlichkeit abgeschlossen wird, aber keinen wesentlichen Unterschied für Ihr Projekt ausmacht.
    • Erfordert die Idee die Beteiligung bestimmter Mitglieder Ihrer Community? Haben sie ausreichend Zeit, daran teilzunehmen?

  • Erstellen Sie Ihr Angebot mithilfe der Angebotsvorlage. Machen Sie sich mit Folgendem vertraut und geben Sie Folgendes an:

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

    Der Vorschlag muss außerdem ein Budget enthalten. Unvollständige Angebote werden nicht berücksichtigt.

  • Das Antragsformular muss bis zum 25. März 2022 um 18:00 Uhr (UTC) eingereicht werden. Akzeptierte Vorschläge werden am 14. April 2022 bekannt gegeben.

Projektentwicklung und Berichterstattung

Projekt-Kickoff

  • Wenn Ihre Organisation bereits einen oder mehrere technische Redakteure für Ihr Projekt ausgewählt hat, vereinbaren Sie ein Kick-off-Meeting mit dieser Person. Sie sollten mit Ihrem technischen Redakteur zusammenarbeiten, um einen Zeitplan für die Arbeiten und regelmäßige Kontaktaufnahmen zu erstellen.
  • Wenn Sie mehrere Interessensbekundungen von interessierten technischen Redakteuren erhalten haben, geben Sie Ihre Auswahl als technischer Redakteur öffentlich bekannt oder informieren Sie Bewerber anderweitig über Ihre Entscheidung.

Zahlungen gewähren

  • Season of Docs überweist ab dem 9. Juni 2022 40% der Fördermittel auf das Open Collective-Konto jeder Organisation, nachdem diese einen technischen Redakteur eingestellt hat. Wir empfehlen Organisationen, einen Zahlungsablauf mit technischen Redakteuren auf der Grundlage von Projektmeilensteinen zu erstellen, einschließlich einer Zahlung beim Projektstart.
  • Die restlichen 60% werden den Open Collective-Konten von Organisationen gutgeschrieben, die ab dem 14. Dezember 2022 ihre abschließenden Bewertungen und Fallstudien ausfüllen und einreichen. Beachten Sie, dass alle erfolgreichen Projekte, unabhängig vom Zeitplan für den Projektabschluss (z. B. 3- oder 6-monatiges Projekt), am 14. Dezember 2022 mit der Abschlusszahlung beginnen.
  • 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 bitte in Ihrem Spamordner nach).

Abschließende Projektbewertung und Fallstudie

Die Organisationen müssen sowohl die Abschlussbewertung des Projekts als auch die Fallstudie vor dem 30. November 2022 um 18:00 Uhr (UTC) abschließen und einreichen, um die restlichen Fördermittel zu erhalten.

Abschließende Bewertung

Das endgültige Bewertungsformular wird Administratoren mindestens einen Monat vor dem 30. November 2022 um 18:00 Uhr (UTC) zur Verfügung gestellt.

Fallstudie

Die Season of Docs-Fallstudie ist der wichtigste Liefergegenstand der Teilnahme Ihres Unternehmens an Season of Docs. Ein wöchentliches Protokoll der Projekt- aktualisierungen hilft Ihnen bei der Erstellung Ihrer Fallstudie. Zeichnen Sie jede Woche den Projektfortschritt auf (einschließlich Links zu Pull-Anfragen, Problemen oder Unterhaltungen, falls hilfreich), was gut (oder nicht gut), was Sie gelernt haben und welche Fragen gestellt wurden.

Weitere Informationen finden Sie unter Fallstudie erstellen. Zum Erstellen Ihrer Fallstudie müssen Sie unserer Fallstudienvorlage folgen. Sie reichen Ihre Fallstudie als Link im abschließenden Bewertungsformular ein.

Ihre Fallstudie wird auf der Website „Season of Docs“ veröffentlicht. Denken Sie daran, wenn Sie Informationen zu Ihrem Projekt hinzufügen.

Organisationen müssen an mindestens drei Folgeumfragen teilnehmen, damit wir den Erfolg von Season of Docs-Projekten im Zeitverlauf verfolgen können.

Formulare

Form Link Frist
Antrag der Organisation

Die Bewerbungsfrist für die Organisation ist abgelaufen. Abonnieren Sie die Mailingliste unter season-of-docs-announce, um auf dem Laufenden zu bleiben.

 25. März 2022 um 18:00 Uhr (UTC)
Zahlungsinformationen der Organisation

Dieses Formular ist noch nicht verfügbar.

 12. Mai 2022 um 18:00 Uhr (UTC)
Nachweis über die Einstellung von technischen Redakteuren

Einstellungsphase für technische Redakteure abgeschlossen.

 16. Mai 2022 um 18:00 Uhr (UTC)
Monatliche Auswertungen

Die monatliche Bewertungsphase ist beendet.

 Zeitachse ansehen
Abschließende Projektbewertung und Fallstudie

Die Projektbewertungsphase ist beendet.

 30. November 2022 um 18:00 Uhr (UTC)
Folgeumfragen

Formular für Folgeumfragen (2. Mai 2023) verfügbar

 Zeitachse ansehen