Fase attuale:
Risultati annunciati
tempistiche.
Nel programma Season of Docs, 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 dichiarazione di interesse deve includere i tuoi dati di contatto, informazioni sulla tua esperienza di scrittura tecnica e una descrizione del lavoro che svolgeresti con l'organizzazione. Dovrebbe inoltre evidenziare il modo in cui soddisfi gli eventuali requisiti specifici dell'organizzazione 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 che ti aiuta a creare la tua dichiarazione di interesse.
Informazioni personali
- Includi il tuo nome e indirizzo email. Se non vuoi che il tuo nome venga incluso nei report pubblici dei case study, indicalo nella proposta e fornisci un nome utente.
Informazioni professionali
- Un link a un portfolio di esempi di scrittura pubblicamente accessibile o singoli link a esempi del tuo lavoro.
- Una panoramica della tua recente esperienza di scrittura tecnica: elenca i tuoi ruoli o le tue esperienze lavorative più recenti. Se hai esperienza con la documentazione open source, includila anche qui. Riepiloga il tuo ruolo, le responsabilità del ruolo e il lavoro che hai completato. Specifica 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 possibili progetti, assicurati che il titolo della 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 stai proponendo. Ad esempio, "Crea documentazione interattiva dell'API ProjectX" è un titolo migliore di "Documentazione per ProjectX".
- Descrizione dettagliata.
- Fornisci una descrizione del tuo approccio al progetto dichiarato dall'organizzazione nella pagina della proposta.
- Spiega in che modo ciò che stai proponendo risolverà il problema o raggiungerà l'obiettivo stabilito dall'organizzazione nella pagina della proposta del progetto.
- Includi un riepilogo di eventuali 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ò utilizzarle come fattore nella valutazione della tua proposta.
- Sequenza temporale proposta
- Fornisci una descrizione generale delle tempistiche e delle fasi del progetto. Ad esempio, potresti prevedere un budget di 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.
- Includere aspettative esplicite in merito alla partecipazione e il feedback dei membri del progetto. Ad esempio, puoi dichiarare che la tempistica dipende dalla ricezione di risposte alle query entro tre giorni.
- Budget proposto
- Consigliamo ai Technical Writer 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 offrire opzioni di budget diverse per documentare le istruzioni di implementazione per due, quattro o sei piattaforme.