Fase attuale:
Case study pubblicati. Consulta la cronologia.
Nel programma Google Season of Docs, le organizzazioni collaborano direttamente con gli autori tecnici per creare, migliorare e aggiornare la documentazione. Le organizzazioni scelgono direttamente gli scrittori tecnici. I redattori tecnici interessati a collaborare con le organizzazioni devono inviare una dichiarazione di interesse utilizzando il canale specificato nella pagina della proposta dell'organizzazione.
La dichiarazione di interesse deve includere i tuoi dati di contatto, informazioni sulla tua esperienza di scrittura tecnica e un'idea generale del lavoro che faresti con l'organizzazione. Dovrebbe anche mettere in evidenza in che modo soddisfi eventuali requisiti specifici dell'organizzazione per i redattori tecnici. Leggi attentamente la pagina delle idee di progetto dell'organizzazione per assicurarti di aver incluso tutte le informazioni richieste.
Questo modello è uno schema che ti aiuta a creare la tua dichiarazione di interesse.
Informazioni personali
- Includi il tuo nome e il tuo indirizzo email. Se non vuoi che il tuo nome venga incluso nei report pubblici del caso studio finale, indicalo nella proposta e fornisci un nome utente.
Informazioni professionali
- Un link a un portfolio di esempi di scrittura accessibile al pubblico o singoli link a esempi del tuo lavoro.
- Una panoramica della tua esperienza recente nella scrittura tecnica: elenca i tuoi ruoli o la tua esperienza lavorativa più recenti nella scrittura tecnica. Se hai esperienza con la documentazione open source, includila anche qui. Riepiloga il tuo ruolo, le relative responsabilità e il lavoro che hai completato. Fornisci le date, se pertinenti.
- Un link al tuo curriculum vitae.
- Se l'organizzazione ha stabilito determinati requisiti per il progetto, includi una o due frasi che descrivono come soddisfi questi requisiti, ad esempio: "Ho partecipato a più di sei correzioni dei documenti come autore tecnico e ho guidato tre correzioni dei documenti per il mio team di XYZ Industries nel 2018, 2019 e 2020".
- (Facoltativo) Eventuali altre informazioni da aggiungere. Ad esempio, il tuo interesse per la documentazione tecnica, il motivo per cui vuoi partecipare a Google Season of Docs o altre esperienze pertinenti.
Dichiarazione del progetto
- Titolo del progetto. Se nella pagina del progetto dell'organizzazione sono elencati diversi progetti possibili, assicurati che il titolo della tua dichiarazione di interesse rifletta il progetto a cui vuoi lavorare. Se invii una dichiarazione di interesse a un'organizzazione che non ha ancora stabilito possibili progetti, il titolo deve riassumere il lavoro che stai proponendo. Ad esempio, "Creare la documentazione interattiva dell'API ProjectX" è un titolo migliore di "Documentazione per ProjectX".
- Descrizione dettagliata.
- Fornisci una descrizione di come affronteresti il progetto indicato dall'organizzazione nella pagina della proposta di progetto.
- Spiega in che modo la tua proposta risolverà il problema o raggiungerà l'obiettivo che l'organizzazione ha stabilito nella pagina della proposta di progetto.
- Includi un riepilogo delle discussioni che hai avuto con i membri dell'organizzazione in merito al progetto.
- Presta attenzione al linguaggio e allo stile della proposta. L'organizzazione open source potrebbe utilizzarli come fattore nella valutazione della tua proposta.
- Tempistiche proposte
- Fornisci una panoramica generale delle tempistiche e delle fasi del progetto. Ad esempio, puoi prevedere due settimane per la raccolta delle informazioni, quattro settimane per la scrittura, due settimane per la revisione e le modifiche e una settimana per la pubblicazione.
- Includi aspettative esplicite per la partecipazione e il feedback dei membri del progetto. Ad esempio, puoi dichiarare che le tempistiche dipendono dalla ricezione di risposte alle query entro tre giorni.
- Budget proposto
- Consigliamo ai redattori tecnici di proporre un budget per l'intero progetto anziché una tariffa oraria.
- Se possibile, offri opzioni per un ambito ridotto o aumentato. Ad esempio, puoi fornire opzioni di budget diverse per la documentazione delle istruzioni di deployment per due, quattro o sei piattaforme.