Fase attuale:
Il programma per la stagione dei documenti 2020 è terminato il 15 marzo 2021. Consulta la cronologia.
Questa è una guida per i mentori open source, membri di organizzazioni open source che partecipano alla Season of Docs come mentori per i Technical Writer.
Introduzione
La guida ti aiuta a eseguire le attività di cui sei responsabile in ogni fase della stagione di Documenti.
Uno dei tuoi obiettivi in qualità di mentore è garantire agli ingegneri tecnici un'esperienza gratificante e di successo nella stagione di Documenti di quest'anno. Ciò migliorerà le possibilità che i Technical writer continuino a contribuire al tuo progetto open source dopo la chiusura della stagione di Documenti di quest'anno e che altri Technical Writer saranno entusiasti di lavorare con l'open source.
Fase di candidatura dell'organizzazione
La fase di candidatura dell'organizzazione va dal 13 aprile 2020 al 4 maggio 2020. Durante questo periodo, l'amministratore dell'organizzazione può inviare una richiesta di partecipazione alla stagione di Documenti da parte dell'organizzazione. Gli amministratori dei programmi Google pubblicano l'elenco delle organizzazioni di successo l'11 maggio 2020.
| Le tue attività di mentore durante questa fase | |
|---|---|
|
Crea il tuo elenco di idee. |
Collabora con l'amministratore dell'organizzazione per creare un elenco di idee per i progetti. L'elenco deve includere uno o più progetti di documentazione che vorresti che un Technical Writer affrontasse durante la stagione dei documenti di quest'anno. |
|
Registrati alla stagione dei documenti. |
Registrati alla Season of Docs il prima possibile. Le registrazioni per la stagione 2020 di Documenti sono chiuse. |
|
Parla della Stagione dei documenti. |
Spargi la voce che la tua organizzazione sta partecipando alla stagione di Documenti. Anche se la tua organizzazione non rientra nell'elenco finale delle organizzazioni accettate quest'anno, è comunque un'ottima notizia che tu abbia fatto parte del processo di selezione. |
Fase di esplorazione del Technical Writer
La fase di esplorazione del Technical Writer va dall'11 maggio all'8 giugno 2020. Durante questo periodo, i Technical Writer esaminano l'elenco delle organizzazioni partecipanti e le idee dei loro progetti. I Technical writer possono rivolgersi direttamente a una o più organizzazioni per discutere delle idee di un progetto.
| Le tue attività di mentore durante questa fase | |
|---|---|
|
Discuti le idee per il progetto con i Technical Writer interessati. |
Puoi discutere delle idee per un progetto con qualsiasi Technical Writer che si rivolge direttamente alla tua organizzazione per aiutarlo a elaborare una valida proposta di progetto da inviare agli amministratori del programma Google. Le idee di progetto possono provenire dall'elenco di idee proposto dalla tua organizzazione oltre ad altre idee proposte dal Technical Writer. |
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, i Technical Writer fanno domanda per partecipare alla Stagione di Documenti e le organizzazioni selezionano i progetti a cui vogliono insegnare.
| Le tue attività di mentore durante questa fase | |
|---|---|
|
Valutare le proposte di Technical Writer. |
Collabora con l'amministratore della tua organizzazione per valutare le proposte del Technical Writer e seleziona i progetti di scrittura tecnica di cui la tua organizzazione vuole fare da mentore durante la stagione dei documenti di quest'anno. |
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 aiutano i Technical Writer accettati ad acquisire familiarità con il progetto open source.
| Le tue attività di mentore durante questa fase | |
|---|---|
|
Presenta al Technical Writer il progetto e la community open source. |
Presenta al Technical writer l'organizzazione open source e aiutalo ad acquisire familiarità con gli strumenti e i processi che utilizzi. |
|
Spiega il tuo prodotto al Technical Writer. |
Dedica del tempo a spiegare il prodotto (soprattutto a livello concettuale) e assicurarti che il Technical Writer comprenda il pubblico della documentazione. |
|
Configura i canali di comunicazione. |
Incoraggia il Technical Writer a presentarsi nelle mailing list della community, nella chat, nel canale Slack e in qualsiasi altro canale di comunicazione condiviso. Assicurati che il Technical Writer abbia un modo affidabile per comunicare direttamente con te. |
|
Definisci obiettivi e aspettative. |
Collabora con il Technical Writer per perfezionare gli obiettivi del suo progetto di Technical Writer e definire aspettative su entrambi i lati. L'obiettivo è garantire il successo del progetto. |
Fase di sviluppo del documento
La fase di sviluppo dei documenti va dal 14 settembre 2020 al 30 novembre 2020. Durante questo periodo, i Technical Writer lavorano ai loro progetti sotto la stretta collaborazione con i loro mentori.
| Le tue attività di mentore durante questa fase | |
|---|---|
|
Consiglia e incoraggia il Technical Writer. |
Collabora a stretto contatto con il Technical Writer per garantire il completamento del progetto. |
|
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. |
Fasi di finalizzazione e valutazione del progetto
La fase di finalizzazione del progetto va dal 3 al 10 dicembre 2020. (le date sono diverse per i progetti di lunga durata). Durante questo periodo, i Technical Writer inviano i loro prodotti di lavoro finali e le loro valutazioni da mentore.
La fase di valutazione del mentore va dal 3 dicembre 2020 al 10 dicembre 2020 alle 18:00 UTC. Durante questo periodo, i mentori inviano le loro valutazioni del successo dei progetti di scrittura tecnica e la loro esperienza di lavoro con i Technical Writer.
| Le tue attività di mentore durante questa fase | |
|---|---|
|
Scrivi e invia la tua valutazione del progetto di scrittura tecnica. |
Completa e invia le tue valutazioni entro il 12 marzo 2021 alle 18:00 UTC. Valutazione di un progetto di scrittura tecnica 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. Durante questo periodo, i Technical Writer inviano i loro prodotti di lavoro finali e le loro valutazioni, mentre i mentori inviano le loro valutazioni.
| Le tue attività di mentore per un progetto di lunga data | |
|---|---|
|
Consiglia il Technical Writer e invia la valutazione del tuo progetto. |
Le attività e le responsabilità sono le stesse descritte in questa pagina per i progetti di scrittura tecnica di lunghezza standard, tranne per il fatto che le date per la finalizzazione e le valutazioni dei progetti sono successive. |
Informazioni correlate
- Consulta la sequenza temporale della stagione di Documenti.
- Consulta la guida per il mentore di Google Summer of Code pertinenti anche per la stagione dei documenti.