Domande frequenti

Fase attuale:
Il programma per la stagione dei documenti 2019 è terminata il 6 marzo 2020. Consulta la cronologia.

Generale

Season of Docs è un programma di selezione del personale?

No. Se ti interessa lavorare per Google, visita il sito web di Google Jobs.

La Season of Docs è considerata un tirocinio, un lavoro o qualsiasi forma di impiego?

No. La stagione dei documenti è un'attività che il Technical writer esegue come Technical writer indipendente per cui riceve uno stipendio. I Technical Writer possono scegliere di non ricevere lo stipendio.

Perché dovrei partecipare alla stagione dei documenti?

L'obiettivo di Season of Docs è promuovere la collaborazione tra organizzazioni open source e Technical Writer. Riteniamo che questo programma:

  • Offri ai tecnici l'opportunità di acquisire esperienza nel contribuire a progetti open source e di saperne di più sul codice open source.
  • Offri ai progetti open source l'opportunità di coinvolgere la community di Technical Writer e, di conseguenza, di migliorare i propri documenti open source.
  • Aumenta la notorietà dei documenti open source e della scrittura tecnica.

Vantaggi per le organizzazioni open source:

  • Esperienza con un Technical Writer.
  • Documenti migliorati.
  • Il potenziale di una collaborazione continua con i Technical writer al termine della Stagione di Documenti.
  • Processi migliorati per la documentazione dei progetti.
  • Maggiore consapevolezza dei documenti open source tra la community di Technical Writer.

Vantaggi per i Technical Writer:

  • Esperienza nel contribuire a un progetto open source.
  • Esperienza di lavoro con documenti incentrati sugli sviluppatori e con la programmazione.
  • Ringraziamento e riconoscimento per il lavoro svolto.
  • Qualcosa da aggiungere al tuo curriculum.
  • Il potenziale di una collaborazione continua con il progetto open source dopo la fine della Stagione di Documenti
  • Maggiore consapevolezza nelle community open source sul valore che i Technical Writer possono apportare.

Quali tipi di progetti possono affrontare i Technical Writer?

Ecco alcuni esempi:

  • Crea un sito di documentazione su una piattaforma a scelta del Technical Writer e del Mentore dell'open source e pubblica un insieme iniziale di documenti di base sul sito. Ecco alcuni esempi di piattaforme:

  • Esegui il refactoring della documentazione esistente del progetto open source per offrire un'esperienza utente migliore o un'architettura delle informazioni più accessibile.

  • Scrivi una panoramica concettuale o un'introduzione a un prodotto o una funzionalità. Spesso un team crea la propria documentazione tecnica dal basso verso l'alto, con il risultato che sono molti i dettagli, ma è difficile comprendere il prodotto nel suo complesso. Un Technical Writer può risolvere il problema.

  • Crea un tutorial per un caso d'uso di alto profilo.

  • Crea una serie di guide illustrative mirate per attività specifiche.

  • Crea una guida per i collaboratori che includa informazioni di base su come iniziare in qualità di collaboratore al progetto open source, nonché tutte le regole relative ai contratti di licenza, le procedure per le richieste di pull e le revisioni, la creazione del progetto e così via.

È possibile che un video sia un progetto per Season of Docs?

Sì. Spetta all'organizzazione open source pubblicare idee di progetto e scegliere una proposta di progetto inviata da un Technical Writer. Se un video soddisfa i requisiti dell'organizzazione open source, puoi inviarlo come progetto Season of Docs, a condizione che si tratti di un video di istruzioni tecniche. Assicurati che i requisiti video siano ben definiti e tieni presente che la produzione di un video di alta qualità richiede tempo e risorse.

Le organizzazioni di mentoring sono tenute a utilizzare i documenti prodotti dai Technical Writer?

No. Anche se ci auguriamo che tutta la documentazione e il codice che scaturisce da questo programma possa essere a beneficio, non chiediamo alle organizzazioni di utilizzare i documenti o il codice dei tecnici.

Dove si svolge la stagione dei documenti?

La stagione dei documenti si svolge interamente online. Non è necessario viaggiare nell'ambito del programma.

Come faccio a ricevere informazioni sulla stagione di Documenti?

Consulta la mailing list dell'annuncio all'indirizzo season-of-docs-announce per gli ultimi aggiornamenti e annunci relativi alla stagione di Documenti. Unisciti al gruppo per ricevere aggiornamenti via email.

Che cosa posso fare per far conoscere la Stagione di Documenti?

Puoi inviare tweet sul programma, scrivere post per i blog, pubblicare video o organizzare un meetup o una sessione informativa nella tua zona. Disponiamo di risorse e contenuti di esempio che puoi utilizzare per distribuire alla tua community (organizzazione, gruppo di autori e altri contatti).

Come faccio a organizzare o ospitare una sessione o un meetup sulla stagione di Documenti?

Puoi fissare un meetup a qualsiasi ora e nel luogo che ti trovi più comodo. Consulta le regole del programma e utilizza i contenuti di esempio.

Posso partecipare alla stagione di Documenti sia come mentore che come Technical Writer?

No. Vogliamo assicurarci che ogni progetto e ogni Technical Writer ricevano sufficiente attenzione e crediamo che questo possa creare un'esperienza negativa per le persone coinvolte. Scegli se la partecipazione come mentore o scrittore tecnico è più allettante per te e pianifica la tua candidatura di conseguenza.

Riceverò una maglietta per la stagione dei documenti?

Sì. I partecipanti ai progetti completati con successo riceveranno una maglietta con documenti della stagione. La maglietta di quest'anno sarà la maglietta del programma inaugurale.

Quando arriverà la mia maglietta?

A causa dell'emergenza COVID-19, al momento non abbiamo una stima relativa a quando riceverai la maglietta. Google ha affidato a un fornitore la produzione delle T-shirt e la gestione della logistica per la loro spedizione in tutto il mondo. Gli amministratori del programma Google ti invieranno un'email con un codice di accesso univoco per selezionare il tuo stile o la tua taglia e inserire i dettagli di spedizione non appena sarà possibile effettuare la produzione. La produzione e la spedizione delle T-shirt richiedono in genere alcune settimane.

A chi mi rivolgo se avessi altre domande?

Dai un'occhiata alla guida per il Technical Writer, la guida per il mentore e la guida per l'amministratore dell'organizzazione.

Se dopo aver letto tutta la documentazione non hai ancora una risposta, valuta se discutere delle tue domande con la community di Season of Docs su Slack o nell'elenco di discussione. Consulta le informazioni sui canali di discussione e su come contattarci.

Per i Technical Writer

Quando i Technical Writer possono richiedere la stagione di Documenti?

La fase di candidatura per Technical Writer va dal 29 maggio 2019 al 28 giugno 2019. Consulta le tempistiche del programma e la guida per i tecnici.

Quali strumenti e framework di documentazione devo conoscere per partecipare alla stagione di Documenti?

Gli strumenti di documentazione e i framework che utilizzerai dipendono dall'organizzazione con cui ti interessa lavorare. Parte dell'obiettivo di Season of Docs, è la realizzazione di progetti open source che aiutino i Technical Writer a saperne di più sugli strumenti e i framework coinvolti nella documentazione dei prodotti open source. Per questo motivo, di solito non è necessario avere una conoscenza dettagliata delle piattaforme di documentazione specifiche prima di iniziare il progetto Season of Docs.

Detto questo, la maggior parte delle organizzazioni open source utilizza un certo stile di Markdown o un altro linguaggio di markup per la propria documentazione. Ti consigliamo di scoprire quale lingua utilizza l'organizzazione che hai scelto e acquisire familiarità con la sintassi. Markdown è un buon inizio, poiché i file README di GitHub utilizzano una versione di Markdown. Consulta la guida di GitHub a Markdown.

Scopri se l'organizzazione che hai scelto ospita già la documentazione su un sito web e, in tal caso, quale piattaforma utilizza. La piattaforma può essere un generatore di siti statici come Jekyll, Sphinx o Hugo, oppure l'organizzazione può ospitare i loro documenti su Leggi i documenti o Pagine GitHub. Una volta che hai scoperto quale piattaforma utilizza l'organizzazione, esplora e sperimenta il linguaggio e il framework pertinenti. Questo ti aiuta a iniziare rapidamente a lavorare al tuo progetto open source e ti mette in condizione di fornire consigli validi al progetto open source di tua scelta.

Quali linguaggi di programmazione devo conoscere per partecipare alla stagione di Documenti?

A seconda della natura del progetto di documentazione, potrebbe essere necessario conoscere un linguaggio di programmazione. Tienilo presente quando scegli e proponi un progetto di documentazione e consulta l'organizzazione open source per conoscere il livello di familiarità richiesto.

Posso inviare più di una proposta di progetto?

Sì, ma sarà accettata una sola proposta di progetto per Technical writer. Consulta la guida alla creazione di un'applicazione.

I Technical Writer che stanno già lavorando a un progetto open source possono continuare a lavorarci nell'ambito della Stagione di Documenti?

Sì, ma devi prendere nota della tua precedente relazione con il progetto nella proposta.

Un gruppo può inviare una proposta insieme per lavorare su un singolo progetto?

No, solo una persona può lavorare a un determinato progetto.

Posso contattare direttamente le organizzazioni di mentoring prima di inviare una proposta per la stagione di Documenti?

Sì, puoi comunicare direttamente con l'organizzazione open source con cui ti interessa collaborare prima di inviare la tua richiesta per la stagione di Documenti. I mentori open source possono aiutarti a perfezionare la tua idea di progetto.

Quali sono i requisiti di idoneità per partecipare?

  • Devi avere almeno 18 anni al momento della registrazione.
  • Devi essere idoneo a lavorare nel paese in cui risiedi durante il periodo di validità del programma.
  • Devi risiedere in un paese attualmente non sottoposto a embargo dagli Stati Uniti. Consulta le regole del programma e le informazioni sui programmi sulle sanzioni e sulle informazioni sui paesi del Tesoro degli Stati Uniti.

Fate un'eccezione ai requisiti di idoneità per me?

No. Non possiamo fare un'eccezione se non soddisfi i requisiti di idoneità, a prescindere dal tuo talento o dal tuo interesse. Fare un'eccezione per te non sarebbe corretto nei confronti degli altri scrittori tecnici che fanno domanda per partecipare alla stagione dei documenti.

Quali moduli dovrò fornire?

I partecipanti accettati dovranno fornire gli appositi moduli fiscali.

Ho bisogno di esperienza o formazione pregressa come Technical Writer?

È preferibile, ma non è essenziale, avere esperienza o formazione pregressa nella scrittura tecnica. Quando invii una proposta di progetto, puoi descrivere la tua esperienza e/o la tua formazione in scrittura tecnica. Dovresti essere in grado di fornire qualche prova che dimostri il tuo interesse per la documentazione tecnica o la documentazione open source, compresi esempi della documentazione che hai scritto. Lo scopo del programma Season of Docs, è quello di collaborare con scrittori tecnici esperti o in formazione con mentori open source, in modo che ognuno possa imparare dagli altri. L'organizzazione open source cercherà tecnici writer con il livello di esperienza necessario all'organizzazione per garantire il completamento corretto dei progetti della stagione dei documenti.

Riceverò un pagamento per la partecipazione alla Stagione dei Documenti?

Sì. Google fornirà uno stipendio ai Technical Writer che completano con successo il programma. Puoi scegliere di non ricevere lo stipendio. Vedi i dettagli dello stipendio di Technical Writer.

Riceverò il pagamento anche se l'organizzazione non utilizza la mia documentazione o il mio codice?

Sì, a condizione che il tuo progetto superi la valutazione finale da parte del tutor dell'open source. Il fatto che il progetto open source utilizzi o meno la documentazione o il codice prodotti non influisce sul pagamento dello stipendio di Technical Writer.

Che aspetto ha una buona proposta di Technical Writer?

Le migliori proposte provengono da tecnici che si occupano del tempo per interagire e discutere le proprie idee con l'organizzazione open source scelta prima di inviare le applicazioni per la stagione delle documenti. Consulta la guida alla creazione di un'applicazione.

Quanto tempo richiede la partecipazione alla stagione dei documenti?

La quantità di tempo che dedichi dipende dalla natura del progetto che hai concordato con la tua organizzazione di mentori. Il requisito del numero di ore è deliberatamente flessibile, per consentire diversi tipi di progetti e stili di lavoro diversi.

Prima di inviare la proposta di progetto, dovresti valutarlo e discutere una stima del tempo con l'organizzazione open source. Se hai difficoltà a dedicare la quantità di tempo concordata a causa di altri impegni, hai la possibilità di completare il progetto in un periodo di tempo più lungo e ricevere comunque lo stipendio e il riconoscimento del lavoro svolto. Quando invii la richiesta per la stagione dei documenti, specifica l'opzione per un progetto di lunga durata.

Sto studiando comunicazione tecnica, ma non ho ancora esperienza lavorativa. Posso partecipare comunque?

Sì. Quando invii la proposta di progetto, elenca i tuoi corsi universitari o universitari nella sezione dedicata alle esperienze lavorative precedenti.

Sono uno studente accettato negli Stati Uniti con visto F1. Come faccio a ottenere l'autorizzazione a partecipare?

Per maggiori dettagli, rivolgiti all'ufficio per gli affari internazionali degli studenti della tua scuola. Google non può fornirti alcun tipo di autorizzazione CPT o OPT.

Tutti i partecipanti accettati riceveranno un'email di conferma dell'accettazione. Non offriamo lettere personalizzate.

In che modo Season of Docs utilizza i dati del mio modulo di richiesta?

Gli amministratori del programma Google trasmettono alcune informazioni della tua applicazione agli amministratori dell'organizzazione open source scelta, in modo che l'organizzazione possa valutare la proposta di progetto.

Se il tuo progetto viene accettato nel programma, Season of Docs pubblica i dettagli del progetto sul sito web.

Consulta la descrizione dell'utilizzo dei dati nella guida al modulo di richiesta per Technical Writer.

Per mentori e amministratori di organizzazioni open source

Voglio saperne di più sulla partecipazione come mentore alla stagione di Documenti. Dove posso trovare maggiori informazioni?

Leggi la guida per il mentore e le regole del programma per ulteriori informazioni su come diventare un mentore per la stagione dei documenti.

Quali sono i requisiti di idoneità per un'organizzazione di tutoraggio?

Per poter partecipare come organizzazione di tutoraggio, devi essere un gruppo che esegue un progetto software senza costi/open source, come BRL-CAD. Il progetto non deve essere una persona giuridica legalmente costituita. Per poter partecipare al programma, le organizzazioni di tutoraggio devono aver già prodotto e rilasciato software con una licenza approvata dall'iniziativa open source e avere almeno due collaboratori che fungano da amministratori e/o mentori per l'intera stagione di Documenti.

Consulta anche i requisiti di idoneità descritti nelle norme del programma e la pagina Sanctions Programs and Country Information del Tesoro degli Stati Uniti.

Le organizzazioni ricevono denaro per la partecipazione alla stagione dei documenti?

Le organizzazioni con una buona reputazione riceveranno uno stipendio per ogni Technical Writer accettato al termine del programma. Ciò a prescindere dal fatto che il progetto del tecnico scritto abbia esito positivo o negativo. Le organizzazioni sono libere di usare questi fondi come preferiscono.

In che modo gli amministratori del programma Google allocano slot per progetti di scrittura tecnica?

Il programma pilota della stagione 2019 di Documenti è limitato a un massimo di 50 progetti di scrittura tecnica in totale.

Come linea guida, prevediamo di accettare un massimo di due progetti per organizzazione, in modo da non avere troppi progetti accettati. Tuttavia, se il processo di selezione senza costi non riempie tutti gli slot, gli amministratori dei programmi Google possono allocare slot aggiuntivi ad alcune organizzazioni.

Quando invii la tua selezione di progetti di scrittura tecnica, puoi quindi selezionare più di due progetti. Assicurati di elencare le selezioni in ordine di priorità, con la tua priorità principale in cima all'elenco.

Nelle tue comunicazioni con i Technical Writer, devi indicare chiaramente che il progetto non è accettato fino a quando gli amministratori del programma Google non pubblicheranno l'elenco dei progetti accettati sul sito web del programma.

Posso partecipare alla stagione di Documenti sia come amministratore dell'organizzazione che come mentore?

Sì. Anche l'amministratore di un'organizzazione può essere un mentore. Non devi compilare un modulo mentore separato. Quando compili il modulo di candidatura per l'organizzazione o il modulo per gli amministratori alternativi, dovresti utilizzare l'opzione del modulo per indicare che agisci anche come mentore.

Posso partecipare come amministratore di un'organizzazione o mentore sia alla stagione dei documenti che alla stagione estiva del codice di Google?

Sì. Season of Docs e Google Summer of Code sono programmi separati. Se disponi della larghezza di banda necessaria per partecipare a entrambi i programmi, non è un problema.

Posso partecipare come amministratore di un'organizzazione o mentore sia alla stagione dei documenti che a Google Code-in?

Sì. La stagione di Documenti e Google Code-in sono programmi separati. Se disponi della larghezza di banda necessaria per partecipare a entrambi i programmi, non è un problema.

Dati archiviati

Come faccio a rimuovere i miei dati dall'archivio della stagione dei documenti?

Contattaci per richiedere la rimozione delle tue informazioni.