Fase attuale:
Il programma Stagione di Documenti 2021 si è concluso il 14 dicembre 2021. Consulta la cronologia.
Nel programma Season of Docs 2021, le organizzazioni lavorano direttamente con i Technical Writer per creare, migliorare e aggiornare la documentazione. Le organizzazioni selezionano direttamente i Technical Writer. I Technical writer interessati a collaborare con le organizzazioni devono presentare una dichiarazione di interesse utilizzando il canale specificato nella pagina della proposta dell'organizzazione.
La tua dichiarazione di interesse deve includere i tuoi dati di contatto, informazioni sulla tua esperienza di scrittura tecnica e una scaletta del lavoro che faresti con l'organizzazione. Dovrebbe anche evidenziare come soddisfi eventuali requisiti specifici che l'organizzazione ha per i Technical Writer. Leggi attentamente la pagina delle idee per i progetti dell'organizzazione per assicurarti di aver incluso tutte le informazioni necessarie.
Questo modello è una struttura per aiutarti a creare la tua dichiarazione di interesse.
Informazioni personali
- Includi il tuo nome e indirizzo email. Se non desideri che il tuo nome venga incluso nei report pubblici dei case study, indicalo nella proposta e indica un nome utente.
Informazioni professionali
- Un link a un portfolio di esempi di scrittura pubblicamente accessibile o link individuali a esempi delle tue opere.
- Una panoramica della tua recente esperienza di scrittura tecnica: elenca i tuoi ruoli di scrittura tecnica più recenti o l'esperienza lavorativa. Se hai esperienza con la documentazione open source, includila anche qui. Riassumi il tuo ruolo, le responsabilità del ruolo e il lavoro che hai completato. Fornisci le date, se pertinenti.
- Un link al tuo curriculum o curriculum vitae (CV).
- Se l'organizzazione ha definito determinati requisiti per il progetto, includi una o due frasi che descrivano come soddisfi tali requisiti, ad esempio "Ho partecipato a più di sei correzioni di documenti in qualità di Technical Writer e ho condotto tre correzioni di documenti per il mio team presso XYZ Industries nel 2018, 2019 e 2020".
- (Facoltativo) Qualsiasi altra informazione che vuoi aggiungere. Ad esempio, il tuo interesse per la documentazione tecnica, il motivo per cui vuoi partecipare alla stagione di Documenti o altre esperienze pertinenti.
Dichiarazione del progetto
- Titolo del progetto. Se la pagina del progetto dell'organizzazione elenca diversi progetti possibili, assicurati che il titolo della tua dichiarazione di interesse rifletta il progetto su cui vuoi lavorare. Se stai presentando una dichiarazione di interesse a un'organizzazione che non ha ancora stabilito possibili progetti, il titolo dovrebbe riassumere il lavoro che intendi proporre. Ad esempio, "Create Interactive ProjectX API documentation" (Crea documentazione API interattiva ProjectX) è un titolo migliore di "Documentazione per ProjectX".
- Descrizione dettagliata.
- Fornisci una descrizione dell'approccio che intendi adottare per il progetto indicato dall'organizzazione nella pagina della proposta del progetto.
- Spiega in che modo ciò che proponi risolverà il problema o raggiungerà l'obiettivo stabilito dall'organizzazione nella pagina della proposta di progetto.
- Includi un riepilogo di tutte le discussioni che hai avuto con i membri dell'organizzazione in merito al progetto.
- Presta attenzione al linguaggio e allo stile della tua proposta. L'organizzazione open source può usarle come fattore nella valutazione della tua proposta.
- Tempistica proposta
- Fornisci una descrizione generale delle tempistiche e delle fasi del progetto. Ad esempio, puoi pianificare un budget di due settimane per la raccolta di informazioni, quattro settimane per la scrittura, due settimane per la revisione e le modifiche e una settimana per la pubblicazione.
- Includere aspettative esplicite relative alla partecipazione e feedback da parte dei membri del progetto. Ad esempio, potresti indicare che la sequenza temporale dipende dalla ricezione di risposte alle query entro tre giorni.
- Budget proposto
- Consigliamo agli autori tecnici di proporre un budget per l'intero progetto, anziché una tariffa oraria.
- Se possibile, fornisci opzioni per un ambito ridotto o ampliato. Ad esempio, puoi fornire opzioni di budget diverse per documentare le istruzioni di implementazione per due, quattro o sei piattaforme.