Guida dell'amministratore dell'organizzazione

Fase attuale:
il programma della Stagione dei documenti 2021 è terminato il 14 dicembre 2021. Consulta la cronologia.

Questa guida è rivolta agli amministratori di organizzazioni che presentano domanda di partecipazione o partecipano al programma Google Season of Docs 2021.

La tua organizzazione dovrebbe partecipare al programma Google Season of Docs 2021?

Utilizza queste domande per capire se il tuo progetto o la tua organizzazione open source dovrebbero partecipare alla Stagione dei documenti di Google.

La tua organizzazione o il tuo progetto:

  • Ritieni che la documentazione nuova o aggiornata possa aiutarti a raggiungere un obiettivo o risolvere un problema nel tuo progetto o nella tua community?
  • Hai una comprensione iniziale o un'ipotesi su come misurare il successo del tuo progetto di documentazione?
  • Ci sono membri della community disposti ad aiutare a reclutare, valutare e integrare un autore tecnico e che sarebbero disponibili a rispondere alle domande e a fornire ulteriore assistenza durante il progetto (6-8 mesi, incluso il periodo di candidatura)?
  • Hai un membro della community che vuole fungere da amministratore dell'organizzazione e coordinare la creazione dell'applicazione, rispondere alle domande degli amministratori del programma e inviare le valutazioni mensili, la valutazione finale e il caso di studio? L'amministratore dell'organizzazione deve anche essere disposto a rispondere ai sondaggi di follow-up dopo il completamento della Stagione dei documenti di Google 2021.

La tua organizzazione deve inoltre soddisfare i requisiti di idoneità al programma, tra cui la possibilità di creare un account Open Collective.

Procedura di richiesta per le organizzazioni

Fase di esplorazione

Sebbene le domande per la Stagione dei documenti di Google 2021 siano aperte dal 9 febbraio 2021, consigliamo vivamente alle organizzazioni di completare i passaggi della fase di esplorazione prima di inviare la domanda.

  • Crea una pagina di proposta di progetto. La pagina della proposta include un elenco di esigenze, obiettivi o problemi chiave, possibili soluzioni di documentazione e possibili metriche. Questa pagina deve essere pubblica e consentire la discussione e i contributi della community. Includi informazioni per i redattori tecnici che vogliono partecipare: dove devono porre domande, esprimere interesse o scoprire di più sul tuo progetto? Per esempi, consulta l'elenco di idee per i progetti.
  • Pubblicizza la pagina della proposta nei tuoi canali della community e aggiungi la tua organizzazione all'elenco delle organizzazioni interessate nel repository GitHub di Google Season of Docs. Ti consigliamo inoltre di condividere il link nel canale #season-of-docs del canale Slack di Write The Docs. La pagina di promozione e stampa include loghi e altri contenuti che puoi utilizzare quando parli della Stagione dei documenti di Google.
  • Per ogni idea di documentazione, valuta le esperienze e le qualifiche di cui un autore tecnico avrebbe bisogno per collaborare con successo con la tua community e la tua organizzazione. Quali competenze la tua community potrebbe aiutare un autore tecnico a sviluppare (ad esempio, l'utilizzo di GitHub o della tua toolchain per la documentazione)? Consulta la guida per lavorare con i redattori tecnici.
  • Chiedi a dei volontari di aiutare a rispondere alle domande dei redattori tecnici interessati.
  • Inizia a esaminare le dichiarazioni di interesse inviate dai redattori tecnici interessati a lavorare con il tuo progetto.

Fase di applicazione

  • Scegli l'idea più promettente dalla pagina della proposta. Ogni organizzazione può inviare una sola proposta. Alcuni aspetti da tenere in considerazione:
    • Quale idea ha suscitato il maggiore interesse tra i redattori tecnici?
    • Quale idea ti aiuterà a risolvere il problema più grande del tuo progetto? È meglio scegliere un'idea più rischiosa che avrà un impatto maggiore rispetto a un'idea per un progetto di documentazione che ha maggiori probabilità di essere completato, ma che non farà una differenza significativa per il tuo progetto.
    • L'idea richiede la partecipazione di membri specifici della tua comunità? Hanno tempo di partecipare?

  • Crea la proposta utilizzando il modello di proposta. Assicurati di comprendere e includere:

    • Il problema che vuoi risolvere
    • L'ambito della documentazione che vuoi migliorare o creare
    • In che modo misurerai l'efficacia della tua documentazione

    La proposta deve includere anche un budget. Le proposte incomplete non verranno prese in considerazione.

  • Invia il modulo di richiesta entro il termine ultimo del 26 marzo 2021 alle ore 18:00 UTC. Le proposte accettate verranno annunciate il 16 aprile 2021.

Sviluppo del progetto e generazione di report

Lancio del progetto

  • Se la tua organizzazione ha già selezionato uno o più autori tecnici per il progetto, organizza una riunione di lancio con l'autore tecnico. Dovresti collaborare con il tuo autore tecnico per creare una pianificazione del lavoro e controlli regolari.
  • Se hai ricevuto più dichiarazioni di interesse da parte di autori di manuali tecnici interessati, annuncia pubblicamente la tua scelta o informa in altro modo i candidati della tua decisione.

Pagamenti delle sovvenzioni

  • Google Season of Docs accrediterà il 40% dei fondi della sovvenzione nell'account Open Collective di ogni organizzazione dopo che avrà assunto un autore tecnico, a partire dal 10 giugno 2021. Consigliamo alle organizzazioni di creare un programma di pagamenti con i redattori tecnici in base ai traguardi del progetto, incluso un pagamento all'avvio del progetto.
  • Il 60% rimanente verrà depositato negli account Open Collective delle organizzazioni che completeranno e invieranno le valutazioni finali e i casi di studio, a partire dal 14 dicembre 2021.
  • Per ulteriori informazioni sulla creazione di un account Open Collective, consulta la guida ai pagamenti.

Report sullo stato del progetto

  • Gli amministratori dell'organizzazione devono compilare i report mensili sullo stato entro una settimana dalla ricezione del link al modulo del report sullo stato (il link verrà inviato via email, quindi controlla la cartella dello spam).

Valutazione finale del progetto e case study

Per ricevere i fondi rimanenti del grant, le organizzazioni devono completare e inviare sia la valutazione finale del progetto sia il caso di studio entro le ore 18:00 UTC del 30 novembre 2021.

Valutazione finale

Il modulo di valutazione finale sarà disponibile per gli amministratori dell'organizzazione almeno un mese prima del 30 novembre 2021 alle 18:00 UTC.

Case study

Il case study del Season of Docs di Google è il principale prodotto della partecipazione della tua organizzazione al Season of Docs di Google 2021. Tenere un log settimanale degli aggiornamenti del progetto ti aiuterà a creare il tuo case study. Per ogni settimana, registra l'avanzamento del progetto (inclusi link a richieste pull, problemi o conversazioni, se utili), cosa è andato bene (o male), cosa hai imparato e le domande che ti sono state poste.

Per ulteriori informazioni, consulta la sezione Creare un case study e assicurati di seguire il nostro modello di case study per creare il tuo case study. Invierai il tuo case study come link nel modulo di valutazione finale.

Il tuo case study verrà pubblicato sul sito di Google Season of Docs, quindi tieni conto di questo aspetto quando includi informazioni sul tuo progetto.

È necessario che le organizzazioni partecipino ad almeno tre sondaggi di follow-up per aiutarci a monitorare il successo dei progetti della Stagione dei documenti di Google nel tempo.

Moduli

Modulo Link Scadenza
Richiesta dell'organizzazione

Le candidature delle organizzazioni sono chiuse. Iscriviti alla mailing list degli annunci all'indirizzo season-of-docs-announce per non perderti nessuna novità.

 26 marzo 2021 alle 18:00 UTC
Dati di pagamento dell'organizzazione

Fase relativa ai dati di pagamento dell'organizzazione completata. Se devi apportare modifiche ai dati di pagamento della tua organizzazione, contatta gli amministratori di Season of Docs.

 12 maggio 2021 alle 18:00 UTC
Prova dell'assunzione di un redattore tecnico

Fase di assunzione di autori tecnici completata.

 17 maggio 2021 alle ore 18:00 UTC
Valutazioni mensili

La fase di valutazione mensile è terminata.

 Visualizza la sequenza temporale
Valutazione finale del progetto e case study

La fase di valutazione del progetto è stata completata.

 30 novembre 2021 alle ore 18:00 UTC
Sondaggi di follow-up

Modulo disponibile durante la fase dei sondaggi di follow-up (1° maggio 2025).

 Visualizza la sequenza temporale