Fase attuale:
Il programma per la stagione dei documenti 2020 è terminato il 15 marzo 2021. Consulta la cronologia.
Questa pagina contiene suggerimenti per i tecnici su come completare le parti principali di un'applicazione per partecipare alla stagione di Documenti. Queste informazioni ti aiutano a comprendere quali fattori le organizzazioni open source potrebbero prendere in considerazione quando selezionano i progetti di scrittura tecnica di cui vogliono essere il mentore durante la stagione di Documenti.
Introduzione
Le seguenti linee guida si applicano in genere alla stagione dei documenti. Ogni singola organizzazione open source può avere criteri di valutazione specifici. Puoi contattare qualsiasi organizzazione partecipante prima di inviare la domanda, per discutere dei suoi requisiti e per pianificare la proposta di progetto. Consulta la fase di esplorazione del Technical Writer descritta nella guida per Technical Writer.
Il modulo di richiesta
Il modulo di richiesta è disponibile nella guida di Technical Writer durante la fase di candidatura per Technical Writer.
Dopo aver inviato il modulo, puoi continuare ad aggiornare le relative informazioni fino alla fine della fase di candidatura per Technical Writer (9 luglio 2020).
Informazioni personali
Il modulo di richiesta richiede le seguenti informazioni personali:
Nome:fornisci il tuo nome completo. Season of Docs non condividerà questo nome con le organizzazioni open source e non lo pubblicherà sul sito web.
Un nome visualizzato a tua scelta: fornisci il nome che vuoi utilizzare come identificatore pubblico durante la partecipazione alla stagione dei documenti. Ti consigliamo vivamente di non utilizzare il tuo nome reale e completo come nome visualizzato. La stagione di Documenti condividerà il tuo nome visualizzato con l'organizzazione open source indicata nel modulo di richiesta. Season of Docs pubblicherà il tuo nome visualizzato sul sito web nell'elenco dei progetti di scrittura tecnica accettati.
Il tuo indirizzo email: fornisci l'indirizzo email associato al tuo Account Google. Per partecipare alla stagione di Documenti devi avere un account Google. Con un Account Google puoi utilizzare un indirizzo email non Gmail. Leggi questo articolo del Centro assistenza. Season of Docs utilizza il tuo indirizzo email per comunicare con te e rendere disponibili le risorse del sito web. Season of Docs condividerà questo indirizzo email con l'organizzazione open source da te indicata nel modulo di richiesta. Season of Docs non pubblicherà questo indirizzo email sul sito web.
Leggi di seguito per un riepilogo di come la Season of Docs utilizza le informazioni presenti nel modulo di richiesta.
Informazioni sulla tua esperienza di scrittura tecnica
Quando i mentori open source e gli amministratori dell'organizzazione esaminano una proposta di progetto, sono interessati alla tua esperienza di scrittura tecnica. Puoi fornire i dettagli del modulo come segue:
Esperienza di scrittura tecnica recente: fino a tre voci in cui puoi elencare i ruoli di scrittura tecnica o l'esperienza lavorativa 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. Se necessario, puoi fornire le date.
Un link al tuo CV o CV:(facoltativo) L'URL di una versione pubblicamente accessibile del tuo curriculum o del tuo curriculum vitae (CV).
Un link agli esempi di lavoro:(facoltativo) L'URL di un portfolio pubblicamente accessibile di campioni di scrittura o singoli link a esempi del tuo lavoro.
Qualsiasi altra cosa che desideri aggiungere: (Facoltativo) Qualsiasi informazione tu voglia aggiungere questa applicazione. Ad esempio, il tuo interesse per la documentazione tecnica, il motivo per cui vuoi partecipare alla stagione di Documenti o altre esperienze pertinenti.
Proposta di progetto
La proposta di progetto è un riepilogo del lavoro di documentazione che vorresti completare mentre lavori con l'organizzazione open source scelta durante la stagione di Documenti.
Puoi inviare un massimo di tre proposte di progetto. Tutte le tue proposte di progetto devono essere nello stesso modulo di richiesta.
Dedica del tempo alla tua proposta di progetto, tenendo presente le seguenti linee guida.
Lavori preparatori:
Esamina l'elenco delle organizzazioni open source partecipanti e scegli una o più organizzazioni che ti interessano. Dai un'occhiata alle idee di progetti proposte da ciascuna delle organizzazioni open source che hai scelto.
Se l'organizzazione che ti interessa non ha suggerito alcuna idea, puoi consultare l'elenco generico di idee per i progetti e basare la tua idea su una di queste. Puoi anche scegliere di inventare una tua idea, se l'organizzazione ha pubblicato o meno idee.
Contatta una o più delle organizzazioni partecipanti per discutere delle idee per il progetto. Per contattarli, usa l'indirizzo email dell'organizzazione indicato nell'elenco delle organizzazioni partecipanti. Le prime discussioni ti aiutano a mettere a punto una buona proposta per il progetto.
La tua proposta di progetto nel modulo di candidatura:
Nome organizzazione open source: inserisci il nome dell'organizzazione open source con cui vuoi lavorare durante la stagione di Documenti. Deve essere una delle organizzazioni partecipanti visualizzate sul sito web Season of Docs.
Nome progetto open source: è il nome del progetto open source su cui vuoi lavorare durante la stagione di Documenti. Il progetto deve appartenere a una delle organizzazioni partecipanti indicate sul sito web della Season of Docs. Per alcune organizzazioni, il nome dell'organizzazione e quello del progetto possono coincidere.
Il nome del progetto di scrittura tecnica proposto. Fornisci un titolo breve e descrittivo che riassuma l'obiettivo principale dell'opera proposta.
Una descrizione dettagliata. Fornisci il maggior numero di dettagli possibile nella descrizione del progetto di scrittura tecnica che intendi proporre. È consentito inserire più paragrafi nel campo della descrizione. Ecco alcune idee su cosa includere:
- Fornisci i dettagli della documentazione che proponi di creare/aggiornare. Se prevedi di aggiornare un documento o un sito esistente, includi un link e descrivi gli aggiornamenti proposti. Se proponi un nuovo documento o un nuovo sito, descrivi i contenuti e il pubblico.
- Indica il motivo per cui proponi la nuova documentazione o gli aggiornamenti.
- Se hai discusso del progetto con qualcuno dell'organizzazione open source, includi un riepilogo del risultato della discussione.
- Presta attenzione al linguaggio e allo stile della tua proposta. L'organizzazione open source può utilizzarli come fattore nella valutazione della proposta.
- Non fornire un link alla descrizione del progetto. La descrizione deve includere tutti i dettagli definitivi del progetto. L'organizzazione open source deve essere in grado di effettuare una selezione in base ai contenuti del modulo di richiesta anziché in base ai contenuti archiviati altrove. Se devi inserire link ad altri contenuti che integrano la descrizione, non è un problema, ma tieni presente che per la selezione dei progetti vengono utilizzati solo i contenuti del modulo di richiesta.
Altri campi importanti del modulo di richiesta
Di seguito sono riportate le linee guida sulle altre informazioni chiave da fornire nel modulo di richiesta:
Scelta di un progetto di lunghezza standard o di lunga durata: il periodo standard per la fase di sviluppo dei documenti della stagione di Documenti è di tre mesi. Se il tuo progetto richiede un periodo di tempo più lungo, devi indicarlo nel modulo di richiesta dopo aver consultato l'organizzazione open source di tua scelta. Consulta la descrizione dei progetti di lunga durata.
Accettare lo stipendio per la stagione dei documenti: la stagione di Documenti paga una somma di denaro agli ingegneri tecnici che hanno completato con successo i loro progetti, a condizione che il Technical writer voglia accettare lo stipendio. Consulta le informazioni sugli stili di Technical Writer. Lo stipendio è facoltativo. Se non desideri ricevere lo stipendio, indica la tua scelta nel modulo di richiesta.
In che modo Season of Docs utilizza le informazioni presenti nel modulo di richiesta
Questa sezione riassume in che modo la Stagione di Documenti utilizza le informazioni contenute nel modulo di richiesta. Nelle sezioni precedenti di questa pagina vengono descritti dettagliatamente i campi chiave.
La tabella elenca i campi chiave. Per ogni campo, la tabella indica se Stagione di documenti:
- Trasmette le informazioni all'organizzazione open source che hai specificato nel modulo di richiesta.
- Pubblica le informazioni nell'elenco dei progetti di scrittura tecnica accettati sul sito web Season of Docs.
| Informazioni sul modulo | Condiviso con l'organizzazione open source? | Visualizzato sul sito web Season of Docs? |
|---|---|---|
| Nome completo | ||
| Nome visualizzato | ||
| Indirizzo email | ||
| Esperienza di scrittura tecnica recente | ||
| Link per il curriculum o il CV | ||
| Link agli esempi di lavoro | ||
| Qualsiasi altra informazione che vuoi aggiungere | ||
| Nome organizzazione/progetto open source | ||
| Nome e descrizione del progetto di Technical Writer | ||
| Progetto di lunga durata o di durata standard | ||
| Accettazione dello stipendio |
Spiegazione dei simboli utilizzati nella tabella sopra:
| Simbolo | Significato del simbolo |
|---|---|
| Sì | |
| No |
Note
Ecco altri punti da tenere presente:
Invio di più proposte di progetto: puoi inviare più di una proposta di progetto, ma la Season of Docs accetta una sola proposta di progetto per scrittore tecnico. Puoi inviare un solo modulo di richiesta. Il modulo consente fino a tre proposte di progetto.
Numero totale di progetti di scrittura tecnica nel programma: la stagione di documenti può accettare solo un determinato numero massimo di progetti di scrittura tecnica. Scopri come funziona l'allocazione degli slot.
Guide correlate
Dai un'occhiata ai suggerimenti per i mentori su come valutare le proposte di Technical Writer. Comprendere i criteri di selezione dei mentori ti aiuta a elaborare una proposta con maggiori probabilità di successo.
Per informazioni procedurali su quando e come inviare la richiesta per la stagione dei documenti, consulta la guida per Technical Writer.