Fase attuale:
Il programma per la stagione dei documenti 2020 è terminato il 15 marzo 2021. Consulta la cronologia.
Questa pagina contiene la guida per i Technical Writer che partecipano alla stagione di Documenti.
Introduzione
Ti diamo il benvenuto nella stagione di Documenti. Questa guida ti descrive brevemente la tua partecipazione alla stagione di Documenti e ti aiuta con le attività da intraprendere in ogni fase del programma.
Idoneità a partecipare alla stagione dei documenti
Per partecipare a Season of Docs in qualità di Technical Writer, devi:
- Avere almeno 18 anni al momento della registrazione.
- Sono in grado di dimostrare l'esperienza pregressa di scrittura tecnica inviando descrizioni dei ruoli ed esempi di lavoro.
- Idoneità a lavorare nel proprio paese di residenza per la durata del programma.
- Risiedere in un paese attualmente non sottoposto a embargo dagli Stati Uniti. Consulta i programmi sulle sanzioni e le informazioni sul paese del Dipartimento del Tesoro degli Stati Uniti.
Consulta i termini completi per gli autori tecnici.
I tuoi mentori open source
I mentori della stagione dei documenti non sono necessariamente Technical Writer e potrebbero avere poca esperienza nella comunicazione tecnica. Sono membri dell'organizzazione open source che conoscono il valore di una buona documentazione e hanno esperienza in processi e strumenti open source.
Il rapporto tra te e i tuoi mentori è una collaborazione. Applichi l'esperienza e le competenze della documentazione all'organizzazione open source. I tuoi mentori contribuiscono alla loro conoscenza dell'open source e del codice. Insieme potete sviluppare documentazione tecnica e migliorare i processi del progetto open source.
Annuncio del programma e fasi di candidatura per l'organizzazione
La data di annuncio per la stagione dei documenti è il 23 marzo 2020. Le organizzazioni open source interessate possono fare domanda per partecipare alla stagione dei documenti tra il 13 aprile 2020 e il 4 maggio 2020. Gli amministratori del programma Google pubblicano l'elenco delle organizzazioni di successo l'11 maggio 2020.
Nel periodo tra l'annuncio del programma e la pubblicazione delle organizzazioni open source partecipanti, dovresti tenere d'occhio le notizie. Puoi tornare su questo sito web e cercare post del blog o altre notizie sul Web. Alcune organizzazioni open source potrebbero condividere le loro idee anche durante la fase di candidatura dell'organizzazione.
Ti invitiamo anche a far conoscere la Stagione di Documenti e il motivo per cui sei interessato al programma. Dai un'occhiata al materiale promozionale per trovare immagini e idee.
Fase di esplorazione del Technical Writer
La fase di esplorazione del Technical Writer va dall'11 maggio all'8 giugno 2020. Durante questo periodo, puoi esplorare l'elenco di organizzazioni partecipanti e le loro idee per i progetti. Questo è un bando di gara per i tecnici: non è necessaria l'approvazione della stagione di Documenti per iniziare. Tuttavia, tieni presente i requisiti di idoneità di cui sopra.
Quando trovi uno o più progetti che ti interessano, contatta direttamente l'organizzazione open source pertinente per discutere delle idee per i progetti.
| Le tue attività di Technical Writer durante questa fase | |
|---|---|
|
Esplora l'elenco delle organizzazioni open source partecipanti e le loro idee per i progetti. |
Esamina l'elenco per trovare un'organizzazione open source con cui lavorare. Esamina i progetti di scrittura tecnica proposti dalle organizzazioni e decidi quali sono quelli più adatti a te. Puoi fare domanda per più di un'organizzazione. In questa fase della Stagione di Documenti è consigliabile valutare più opzioni. Il processo di selezione finale accetta un solo progetto per Technical Writer. |
|
Discuti le idee per i progetti con organizzazioni open source. |
Puoi discutere delle idee per un progetto con una qualsiasi delle organizzazioni partecipanti. Per effettuare un contatto, utilizza l'indirizzo email dell'organizzazione mostrato nell'elenco delle organizzazioni partecipanti. Le prime discussioni ti aiutano a mettere a punto una buona proposta di progetto da inviare agli amministratori del programma Google durante la fase di candidatura per Technical Writer. Le idee iniziali per il progetto possono provenire dall'elenco di idee proposto dall'organizzazione. Puoi anche proporre le tue idee. |
Fase di candidatura per Technical Writer
La fase di candidatura per Technical Writer va dal 9 giugno 2020 al 9 luglio 2020. Durante questo periodo, puoi chiedere di partecipare alla stagione di Documenti. Gli amministratori del programma Google inoltrano i dettagli pertinenti della tua applicazione all'organizzazione open source scelta. Gli amministratori e i mentori dell'organizzazione open source selezionano quindi i progetti di cui vogliono eseguire il mentore.
| Le tue attività come Technical Writer candidato durante questa fase | |
|---|---|
|
Invia la tua domanda per partecipare alla stagione di Documenti. |
Invia la richiesta per la stagione dei documenti prima del 9 luglio 2020. Creazione dell'applicazione in corso Le candidature per Technical writer per la stagione 2020 di Documenti sono chiuse. Iscriviti alla mailing list di season-of-docs-announce per non perderti le novità. |
Fase di legame con la comunità
La fase di collegamento tra community va dal 17 agosto al 13 settembre 2020. Durante questo periodo, i mentori open source ti aiutano ad acquisire familiarità con il progetto open source e la community.
| Le tue attività di Technical Writer durante questa fase | |
|---|---|
|
Configura i canali di comunicazione. |
Entra in contatto con i tuoi mentori nell'organizzazione open source con cui hai scelto di lavorare. Assicurati di disporre di un modo affidabile per comunicare direttamente con il tuo mentore e con gli amministratori dell'organizzazione, che sono i membri dell'organizzazione open source che agiscono come contatto principale per la stagione dei Documenti per la loro organizzazione. |
|
Partecipa al progetto open source e alla community. |
Fai domande al tuo mentore sugli strumenti e sui processi utilizzati dall'organizzazione open source. Presentati sulle mailing list, sulla chat, sul canale Slack e su qualsiasi altro canale di comunicazione condiviso della community open source. |
|
Comprendere il prodotto nel suo complesso. |
Chiedi al tuo mentore di spiegare il prodotto (soprattutto a livello concettuale) che documenterai presto. Discuti in dettaglio i partecipanti alla documentazione. |
|
Definisci obiettivi e aspettative. |
Collabora con il tuo mentore per perfezionare gli obiettivi del tuo progetto di scrittura tecnica e definire le aspettative su entrambi i lati. Impostare ora questi obiettivi e aspettative è un buon modo per garantire il successo del tuo progetto. |
Fase di sviluppo del documento
La fase di sviluppo dei documenti va dal 14 settembre 2020 al 30 novembre 2020. (la data di fine è diversa per i progetti di lunga durata). Durante questo periodo, lavorerai al progetto in stretta consultazione con i tuoi mentori.
| Le tue attività di Technical Writer durante questa fase | |
|---|---|
|
Collabora con il tuo mentore per completare il progetto. |
Collabora con il tuo mentore per completare il progetto. Segui le procedure della community open source per richiedere revisioni della documentazione risultante e per inviare gli aggiornamenti al repository open source. Ad esempio, i progetti open source ospitati su GitHub aggiungono o aggiornano file creando una richiesta di pull per la revisione e l'invio. |
|
Segnala eventuali dubbi all'amministratore dell'organizzazione. |
In caso di dubbi sulla comunicazione con i tuoi mentori o di altri problemi che potrebbero influire sul completamento del progetto, informa l'amministratore dell'organizzazione open source. |
|
Completare i sondaggi degli amministratori del programma Google. |
Gli amministratori del programma Google possono inviare un sondaggio a metà progetto per valutare i progressi. Completa il sondaggio e invia le tue risposte agli amministratori del programma Google come indicato nel documento del sondaggio. |
Fase di finalizzazione e valutazione del progetto
La fase di finalizzazione del progetto va dal 30 novembre al 5 dicembre 2020 e la fase di valutazione dal 3 al 10 dicembre 2020. (le date sono diverse per i progetti di lunga durata). Durante il periodo di finalizzazione del progetto, invii il report sul progetto, chiamato anche prodotto finale del lavoro. Durante la fase di valutazione, invii la tua valutazione dei mentori e della tua esperienza come partecipante alla Stagione di Documenti.
| Le tue attività di Technical Writer durante questa fase | |
|---|---|
|
Scrivi il report del progetto. |
Scrivi il tuo report sul progetto (a volte chiamato prodotto di lavoro). Il report sul progetto include una descrizione del lavoro che hai svolto durante la stagione di Documenti ed eventuali link pertinenti. Creazione del report sul progetto La fase di finalizzazione del progetto di lunga durata è stata chiusa. |
|
Chiedi al tuo mentore di esaminare il report del progetto. |
Il tuo mentore potrebbe avere insight preziosi su come descrivere i tuoi risultati. Inoltre, in questa fase è utile raggiungere una comprensione condivisa dello stato del progetto, prima che il tuo mentore contrassegni il progetto come completato correttamente o meno. |
|
Finalizza il report sul progetto. |
Finalizza il report sul progetto entro l'8 marzo 2021 alle 18:00 UTC. Il modulo è modificabile, ma devi inviare la versione finale entro la data indicata. La fase di finalizzazione del progetto di lunga durata è stata chiusa. |
|
Scrivi e invia la valutazione del tuo mentore e la tua esperienza con la Stagione di Documenti. |
Completa e invia la valutazione entro il 12 marzo 2021 alle 18:00 UTC. Valutazioni di Technical Writer La fase di valutazione di un progetto di lunga durata è stata chiusa. |
Progetti di lunga durata
Per i progetti di scrittura tecnica di lunghezza standard in Season of Docs, la fase di sviluppo dei documenti va dal 14 settembre 2020 al 30 novembre 2020. Tuttavia, alcuni Technical Writer possono fare richiesta per un progetto a lungo termine in consultazione con l'organizzazione open source. Per un progetto di lunga durata, la fase di sviluppo del documento va dal 14 settembre 2020 al 1° marzo 2021.
Il periodo di finalizzazione e valutazione per i progetti di lunga durata va dal 1° all'8 marzo 2021.
Le tue attività e responsabilità sono le stesse descritte in questa pagina per i progetti di scrittura tecnica di lunghezza standard, con la differenza che le date per la finalizzazione e le valutazioni dei progetti sono successive.
Informazioni correlate
- Consulta la sequenza temporale della stagione di Documenti.
- Per saperne di più sulla tua relazione con l'organizzazione open source che hai scelto, leggi le responsabilità dell'amministratore e del mentore dell'organizzazione e le linee guida per il mentore sulla collaborazione con un Technical Writer.