Fase attuale:
Il programma Stagione di Documenti 2021 si è concluso il 14 dicembre 2021. Consulta la cronologia.
Questa guida è destinata agli amministratori di organizzazioni che richiedono o partecipano al programma Stagione di Documenti 2021.
La tua organizzazione deve partecipare al programma Stagione di Documenti 2021?
Utilizza queste domande per capire se la tua organizzazione o il tuo progetto open source deve partecipare a Season of Docs.
La tua organizzazione o il tuo progetto:
- Ritieni che la documentazione nuova o aggiornata ti aiuterebbe 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 disposti ad aiutare a reclutare, valutare e inserire un Technical Writer e chi sarebbe disponibile a rispondere alle domande e a fornire ulteriore assistenza durante il progetto (6-8 mesi, compreso il periodo di candidatura)?
- Hai un membro della community disposto a ricoprire il ruolo di amministratore dell'organizzazione e a coordinare la creazione della candidatura, rispondere alle domande degli amministratori del programma e inviare valutazioni mensili, nonché la valutazione finale e il case study? L'amministratore dell'organizzazione dovrebbe anche essere disponibile a rispondere ai sondaggi di follow-up al termine della stagione 2021 di Documenti.
La tua organizzazione deve inoltre soddisfare i requisiti di idoneità del programma, inclusa la possibilità di creare un account Open Collective.
La procedura di richiesta dell'organizzazione
Fase di esplorazione
Anche se le candidature per la stagione dei documenti per la stagione 2021 sono aperte il 9 febbraio 2021, consigliamo vivamente alle organizzazioni di completare i passaggi della fase di esplorazione prima di inviare la domanda.
- Pagina Crea una proposta per il progetto. La pagina della proposta include un elenco di esigenze, obiettivi o problemi fondamentali, possibili soluzioni di documentazione e possibili metriche. Questa pagina deve essere pubblica e consentire la collaborazione e le discussioni della community. Includi informazioni per gli autori tecnici che desiderano partecipare: dove dovrebbero porre domande, esprimere interesse o scoprire di più sul tuo progetto? Consulta l'elenco di idee per i progetti per vedere alcuni esempi.
- Pubblicizza la pagina della proposta nei canali della community e aggiungi la tua organizzazione all'elenco delle organizzazioni interessate nel repository GitHub della stagione dei documenti. Puoi anche condividere il link nel canale #season-of-docs in Write The Docs Slack. La pagina della promozione e della stampa include loghi e altri contenuti che puoi utilizzare quando si parla di Season of Docs.
- Per ogni idea di documentazione, considera di quale esperienza e quali qualifiche avrà bisogno un Technical writer per lavorare in modo efficace con la tua comunità e la tua organizzazione. Quali competenze la tua community potrebbe aiutare a sviluppare un Technical Writer (ad esempio, utilizzando GitHub o la tua toolchain per i documenti)? Consulta la guida per collaborare con i Technical Writer.
- Chiedi a volontari di aiutarti a rispondere alle domande di Technical Writer interessati.
- Inizia a esaminare le dichiarazioni di interesse inviate da scrittori tecnici interessati a lavorare con il tuo progetto.
Fase di applicazione
- Scegli l'idea più promettente nella pagina della proposta. Ogni organizzazione può presentare
una sola proposta. Alcuni aspetti da considerare:
- Quale idea ha ricevuto il maggiore interesse da parte dei Technical Writer?
- Quale idea ti aiuterà a risolvere il problema maggiore del tuo progetto? È preferibile scegliere un'idea più rischiosa che avrebbe 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à? Ha tempo per partecipare?
Crea la tua 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
- Come misurerai il successo della documentazione
La proposta deve includere anche un budget. Le proposte incomplete non saranno prese in considerazione.
Invia il modulo di candidatura entro il termine ultimo del 26 marzo 2021 alle ore 18:00 UTC. Le proposte accettate verranno annunciate il 16 aprile 2021.
Sviluppo e reporting di progetti
Avvio del progetto
- Se la tua organizzazione ha già selezionato uno o più Technical Writer per il tuo progetto, organizza una riunione preliminare con il Technical Writer. Dovresti collaborare con il tuo Technical Writer per creare un programma per il lavoro e regolari verifiche.
- Se hai ricevuto diverse dichiarazioni di interesse da parte di Technical writer interessati, pubblica un annuncio relativo alla tua selezione di Technical writer oppure informa i candidati della tua decisione.
Concedi pagamenti
- Season of Docs accrediterà il 40% dei fondi della sovvenzione nell'account Open Collective di ciascuna organizzazione, dopo l'assunzione di un Technical Writer, a partire dal 10 giugno 2021. Consigliamo alle organizzazioni di creare un calendario dei pagamenti con Technical Writer in base agli obiettivi del progetto, incluso un pagamento al lancio del progetto.
- Il restante 60% verrà depositato sugli account Open Collective delle organizzazioni che completano e inviano le valutazioni finali e i case study, a partire dal 14 dicembre 2021.
- Consulta la guida ai pagamenti per ulteriori informazioni sulla creazione di un account Open Collective.
Report sullo stato dei progetti
- Gli amministratori dell'organizzazione devono compilare i report di stato mensili entro una settimana dalla ricezione del link al modulo del report sullo stato (il link verrà inviato via email, quindi controlla nella cartella dello spam).
Valutazione finale del progetto e case study
Per ricevere i fondi rimanenti, le organizzazioni devono completare e inviare sia la valutazione finale del progetto sia il case study entro le ore 18:00 UTC del 30 novembre 2021.
Valutazione finale
Il modulo di valutazione finale sarà disponibile per gli amministratori dell'organizzazione un mese prima delle 18:00 UTC del 30 novembre 2021.
Case study
Il case study della stagione di Documenti è il documento principale della partecipazione della tua organizzazione alla stagione dei documenti 2021. Tenere un log settimanale degli aggiornamenti del progetto ti aiuterà a creare il tuo case study. Ogni settimana, registra l'avanzamento del progetto (inclusi link per richieste di pull, problemi o conversazioni, se utile), ciò che è andato bene (o meno), ciò che hai imparato e le domande che sono state poste.
Per ulteriori informazioni, leggi l'articolo su come creare un case study e segui il nostro modello di case study per creare il tuo case study. Invierai il tuo case study sotto forma di link nel modulo di valutazione finale.
Il tuo case study verrà pubblicato sul sito Season of Docs, pertanto tienilo a mente quando includi informazioni sul tuo progetto.
Chiediamo alle organizzazioni di partecipare ad almeno tre sondaggi di follow-up per aiutarci a monitorare il successo dei progetti Season of Docs nel tempo.
Moduli
| Modulo | Collegamento | Scadenza |
|---|---|---|
| Applicazione dell'organizzazione | Le candidature dell'organizzazione sono chiuse. Iscriviti alla mailing list per l'annuncio di season-of-docs-announce per non perderti nulla. |
26 marzo 2021 alle 18:00 UTC |
| Dati di pagamento dell'organizzazione | Fase dei dati di pagamento dell'organizzazione completata. Se devi apportare modifiche ai dati di pagamento della tua organizzazione, contatta gli amministratori della stagione dei documenti. |
12 maggio 2021 alle 18:00 UTC |
| Prova dell'assunzione di un Technical Writer | Fase di assunzione del Technical Writer completata. |
17 maggio 2021 alle 18:00 UTC |
| Valutazioni mensili | Visualizza la cronologia | |
| Valutazione finale del progetto e case study | Modulo disponibile durante la fase di valutazione finale del progetto e di case study (22 novembre 2024 - 10 dicembre 2024). |
30 novembre 2021 alle 18:00 UTC |
| Sondaggi di follow-up | Modulo disponibile durante la fase dei sondaggi di follow-up (1° maggio 2025). |
Visualizza la cronologia |
Informazioni correlate
- Esamina la sequenza temporale della stagione dei documenti.