Fase attuale:
Finalizzazione del progetto. Consulta la cronologia.
Questa guida è rivolta agli amministratori delle organizzazioni che presentano domanda di partecipazione o partecipano al programma Google Season of Docs.
La tua organizzazione dovrebbe partecipare al programma Google Season of Docs?
Utilizza queste domande per capire se il tuo progetto o la tua organizzazione open source dovrebbe 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?
- I membri della community sono disponibili ad aiutare a reclutare, valutare e integrare un autore tecnico e a rispondere alle domande e fornire altro supporto 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 case study? L'amministratore dell'organizzazione deve inoltre essere disposto a rispondere ai sondaggi di follow-up dopo il completamento del programma Google Season of Docs.
La tua organizzazione deve inoltre soddisfare i requisiti di idoneità al programma, inclusa la possibilità di creare un account Open Collective.
Procedura di richiesta per le organizzazioni
La procedura di richiesta dell'organizzazione prevede due fasi: la fase di esplorazione e la fase di richiesta.
Fase di esplorazione
Anche se le domande per la stagione di Documenti Google si aprono il 22 febbraio 2024, consigliamo vivamente alle organizzazioni di prendersi il tempo 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 bisogni, obiettivi o problemi chiave, possibili soluzioni di documentazione e possibili metriche. Questa pagina deve essere pubblica e consentire i contributi e le discussioni della community. Includi informazioni per i redattori tecnici che vogliono partecipare: dove devono porre domande, esprimere il loro interesse o approfondire il tuo progetto? Ti consigliamo di aggiungere un indirizzo email per contattare la tua organizzazione open source in merito alla Stagione dei documenti di Google. Tuttavia, sconsigliamo vivamente di utilizzare un indirizzo email personale come indirizzo email per contattare la tua organizzazione open source. Per esempi, consulta l'elenco di idee per 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 gruppo Write The Docs su Slack. La pagina per la promozione e la 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 suite di strumenti per la documentazione)? Consulta la guida per lavorare con gli autori tecnici.
- Chiedi a dei volontari di aiutarti a rispondere alle domande dei technical writer interessati.
- Inizia a esaminare le dichiarazioni di interesse inviate dai redattori tecnici interessati a collaborare 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 per le proposte. Assicurati di comprendere e includere quanto segue:
- 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 possono essere prese in considerazione.
Invia il modulo di richiesta entro il 2 aprile 2024 alle ore 18:00 UTC. Le proposte accettate verranno annunciate il 10 aprile 2024.
Sviluppo del progetto e generazione di report
Gli amministratori dell'organizzazione devono comprendere le proprie responsabilità durante ciascuna fase del programma.
Lancio del progetto
- Se la tua organizzazione ha già selezionato uno o più autori tecnici per il tuo progetto, organizza una riunione di lancio con l'autore tecnico. Devi 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 tecnici interessati, fai un annuncio pubblico della selezione dell'autore tecnico 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 dall'11 giugno 2024. 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 completano e inviano le valutazioni finali e i casi di studio, a partire dal 13 dicembre 2024. Tutti i progetti approvati inizieranno a ricevere il pagamento finale il 13 dicembre 2024
- 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 se non lo vedi).
Valutazione finale del progetto e case study
Per ricevere i fondi rimanenti della sovvenzione, le organizzazioni devono completare e inviare sia la valutazione finale del progetto sia il case study entro le ore 18:00 UTC del 10 dicembre 2024.
Valutazione finale
I moduli di valutazione finale e del caso di studio saranno disponibili per gli amministratori dell'organizzazione non meno di un mese prima del 10 dicembre 2024 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. 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. Invia il tuo case study come link nel modulo del case study.
Il tuo case study verrà pubblicato sul sito di Google Season of Docs, quindi tienilo presente quando includi informazioni sul tuo progetto.
Sondaggi di follow-up
Le organizzazioni accettate sono tenute a partecipare ad almeno tre indagini di follow-up per contribuire a monitorare il successo dei progetti Google Season of Docs nel tempo. I sondaggi di follow-up sono fondamentali per comprendere l'impatto della Stagione dei documenti di Google.
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 rimanere al corrente. |
2 aprile 2024 alle ore 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. |
22 maggio 2024 alle ore 18:00 UTC |
| Prova dell'assunzione di un redattore tecnico |
Fase di assunzione di autori tecnici completata. |
22 maggio 2024 alle ore 18:00 UTC |
| Valutazioni mensili |
La fase di valutazione mensile è terminata. |
Visualizza la sequenza temporale |
| Invio del case study | 10 dicembre 2024 alle ore 18:00 UTC | |
| Valutazione finale del programma | 10 dicembre 2024 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 |
Informazioni correlate
- Consulta la cronologia del Season of Docs di Google.