Domande frequenti

Fase attuale:
Case study pubblicati. Consulta la cronologia.

Generale

Google Season of Docs è un programma di reclutamento?

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

Qual è la differenza tra il programma attuale e la Stagione dei documenti di Google 2019 e 2020?

L'attuale programma della Stagione dei documenti di Google presenta modifiche significative rispetto agli anni precedenti, tra cui:

  • Gli autori tecnici non possono più presentare domanda tramite Google per essere abbinati alle organizzazioni
  • Le organizzazioni inviano proposte di progetto nell'ambito della domanda, tra cui un budget e le metriche proposte
  • Le organizzazioni accettate ricevono sovvenzioni, che utilizzano per pagare i redattori tecnici
  • Le organizzazioni inviano valutazioni finali e case study

Perché Google ha apportato queste modifiche durante la stagione di Documenti?

La nostra missione in Google è organizzare le informazioni a livello mondiale e renderle universalmente accessibili e utili. Riorientando la stagione della documentazione di Google per mettere in evidenza l'apprendimento di pratiche di documentazione efficaci nell'open source, ci auguriamo di avere un impatto maggiore a lungo termine.

La nostra organizzazione vorrebbe partecipare a Google Season of Docs, ma non sa da dove iniziare.

Dai un'occhiata al nostro elenco completo di idee per progetti. Puoi anche contattare la community di scrittura tecnica (prova il canale #season-of-docs nel gruppo Write the Docs Slack o sui tuoi canali di social media per chiedere aiuto o proposte).

Quali tipi di progetti possono proporre le organizzazioni?

Ecco alcuni esempi:

  • Crea un sito di documentazione su una piattaforma da decidere in base alle esigenze dello scrittore tecnico e dell'organizzazione 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 migliorata o un'architettura delle informazioni più accessibile.

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

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

  • Crea una serie di guide dettagliate per attività specifiche.

  • Crea una guida per i collaboratori che includa informazioni di base su come iniziare a collaborare al progetto open source, nonché eventuali regole relative ai contratti di licenza, alle procedure per le richieste pull e le revisioni, alla compilazione del progetto e così via.

Un video è un possibile progetto per la Stagione dei documenti di Google?

Sì. Assicurati che i requisiti relativi ai video siano ben definiti e tieni presente che la produzione di un video di alta qualità richiede tempo e risorse considerevoli.

Un controllo della documentazione è un progetto ragionevole per la Stagione dei documenti di Google?

Un controllo della documentazione è un ottimo progetto per la Stagione della documentazione di Google. Tieni presente la quantità di documentazione di cui disponi. Se è molta, potresti dover ridurre l'ambito (ad esempio, eseguire solo il controllo dei contenuti dei tutorial). Se hai poca o nessuna documentazione, ti consigliamo di includere la creazione della documentazione mancante di massima priorità nel tuo progetto.

Esistono modelli di documentazione disponibili per le organizzazioni e i redattori tecnici?

La stagione della documentazione di Google ha un repository GitHub con un modello e un elenco di controllo per eseguire controlli della documentazione. Ci auguriamo di aggiungere altri modelli man mano che vengono creati.

Il progetto Good Docs si impegna a creare alcuni modelli di documentazione minimamente utili per l'open source.

Le organizzazioni sono tenute a utilizzare i documenti prodotti dai redattori tecnici?

No. A volte i progetti non vanno come previsto o i requisiti cambiano. Non chiediamo alle organizzazioni di utilizzare la documentazione o altri materiali prodotti, ma ci aspettiamo che la valutazione finale e il caso studio includano una discussione sul motivo per cui la documentazione non è stata utilizzata e su come il progetto ha preso la decisione di non utilizzare la documentazione o altri materiali.

Dove si svolge la stagione dei documenti di Google?

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

Come faccio a rimanere al corrente della Stagione dei documenti di Google?

Visita la mailing list degli annunci all'indirizzo season-of-docs-announce per gli ultimi aggiornamenti e annunci relativi alla Stagione dei documenti di Google. Unisciti al gruppo per ricevere aggiornamenti via email.

Posso aggiungere la cronologia della stagione dei documenti di Google al mio calendario?

Sì, puoi aggiungerlo tramite questo link.

Cosa posso fare per contribuire a far conoscere la stagione dei documenti di Google?

Puoi twittare sul programma, scrivere post del blog, pubblicare video o organizzare un incontro o una sessione informativa nella tua zona. Abbiamo alcuni contenuti e risorse di esempio che puoi distribuire alla tua community (organizzazione, gruppo di autori e altri contatti).

Come faccio a organizzare o ospitare una sessione informativa o un meetup di Google Season of Docs?

Puoi fissare un incontro all'ora e nel luogo che preferisci. Consulta le regole del programma e utilizza i contenuti di esempio.

Puoi condividere statistiche sulle stagioni di Documenti 2019 e 2020?

Sì, i risultati della stagione di Documenti Google per il programma 2019 sono disponibili qui, mentre i risultati del programma 2020 sono disponibili qui.

Riceverò una t-shirt di Google Season of Docs?

No, a causa di limitazioni di spedizione internazionali, non potremo più fornire t-shirt ai partecipanti che completano correttamente il progetto della stagione dei documenti di Google.

E se avessi altre domande?

Consulta la guida per gli amministratori dell'organizzazione e la guida per gli autori tecnici.

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

Come faccio a diventare un mentor per la stagione di Documenti Google?

Google Season of Docs non ha un ruolo formale di mentore. Le organizzazioni devono specificare in che modo i redattori tecnici verranno integrati e supportati e in che modo i loro contributi alla documentazione verranno esaminati e approvati nell'ambito della richiesta dell'organizzazione. Se ti interessa fare da mentore a technical writer nell'ambito della stagione dei documenti di Google, ti invitiamo a collaborare con gli amministratori della tua organizzazione per offrire il tuo contributo.

Google Season of Docs è simile a Google Summer of Code?

No. Google Season of Docs è rivolto a persone con una certa esperienza nella scrittura tecnica e non è progettato come un programma di tutoraggio come Google Summer of Code.

Per gli scrittori tecnici

Quando possono gli autori tecnici presentare domanda per la stagione dei documenti di Google?

Google Season of Docs non prevede un'applicazione formale per gli autori tecnici. Per partecipare a Google Season of Docs come autore tecnico, contatta direttamente le organizzazioni open source seguendo le istruzioni riportate nella pagina del programma Google Season of Docs. Puoi anche esprimere il tuo interesse inserendoti nella directory dei Technical Writer di Google Season of Docs. Per ulteriori informazioni, consulta la guida per gli autori di manuali tecnici.

Quali strumenti e framework di documentazione devo conoscere per partecipare alla Stagione della documentazione di Google?

Gli strumenti e i framework di documentazione che utilizzerai dipendono dall'organizzazione con cui vuoi collaborare. Uno degli obiettivi della stagione dei documenti di Google è aiutare i redattori tecnici a scoprire di più sugli strumenti e sui framework coinvolti nella documentazione dei prodotti open source. Per questo motivo, in genere non è necessario disporre di conoscenze dettagliate su piattaforme di documentazione specifiche prima di iniziare il progetto Google Season of Docs.

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

Scopri se l'organizzazione che hai scelto ospita già la propria documentazione su un sito web e, in caso affermativo, quale piattaforma utilizza. La piattaforma può essere un generatore di siti statici come Jekyll, Sphinx o Hugo oppure l'organizzazione può ospitare i propri documenti su Read the Docs o GitHub Pages. Una volta scoperta la piattaforma utilizzata dall'organizzazione, esplora e sperimenta il linguaggio e il framework pertinenti. In questo modo puoi iniziare rapidamente a utilizzare il tuo progetto open source e hai a disposizione tutte le informazioni necessarie per fornire ottimi consigli al progetto open source di tua scelta.

Quali linguaggi di programmazione devo conoscere per partecipare ai progetti di Google Season of Docs?

A seconda della natura del progetto di documentazione, potresti dover conoscere un linguaggio di programmazione. Tieni presente questo aspetto quando scegli e proponi un progetto di documentazione e consulta l'organizzazione open source in merito al livello di familiarità richiesto.

I redattori tecnici che già lavorano a un progetto open source possono continuare a farlo nell'ambito della Stagione dei documenti di Google?

Sì, ma l'organizzazione deve indicare nella proposta il rapporto precedente o in corso del redattore tecnico con il progetto.

Quali sono i requisiti di idoneità per la partecipazione?

È necessaria esperienza o formazione pregressa come Technical Writer?

È preferibile, ma non essenziale, avere esperienza o formazione in scrittura tecnica. Quando invii una dichiarazione di interesse a un'organizzazione, puoi descrivere la tua esperienza e/o la tua formazione nella scrittura tecnica. Dovresti essere in grado di fornire alcune prove che dimostrino il tuo interesse per la documentazione tecnica o la documentazione open source, inclusi esempi di documentazione che hai scritto. L'organizzazione open source cercherà autori tecnici con il livello di esperienza di cui ha bisogno per garantire il completamento dei progetti Google Season of Docs.

Riceverò un pagamento per la partecipazione a Google Season of Docs?

Sì. Google fornirà alle organizzazioni accettate delle sovvenzioni da utilizzare per assumere scrittori tecnici.

Che aspetto ha una buona dichiarazione di interesse per un redattore tecnico?

Le migliori dichiarazioni di interesse provengono da autori tecnici che si prendono il tempo di interagire e discutere le proprie idee con l'organizzazione open source scelta prima di inviare le dichiarazioni. Consulta la guida alla creazione della dichiarazione di interesse.

Quanto tempo richiede la partecipazione a Google Season of Docs?

Le dimensioni dei progetti variano, ma vanno da un impegno di 5-30 ore settimanali durante il programma. Tuttavia, il tempo che impieghi dipende dalla natura del progetto concordato con la tua organizzazione. Prima di eseguire il commit, devi valutare il progetto e discutere una stima dei tempi con l'organizzazione open source.

Posso inviare una richiesta per un'organizzazione per creare la documentazione di un progetto open source come privato? Vorrei creare una serie di post del blog, video o altri materiali su come utilizzare uno strumento o un progetto open source, ma non faccio parte del progetto né sono un collaboratore.

No, devi inviare una proposta solo se puoi ricevere fondi per conto del progetto open source. Ti invitiamo a contattare il progetto e collaborare a una proposta di applicazione.

Sono uno studente. Posso partecipare a Google Season of Docs? La stagione dei documenti di Google mi insegnerà a diventare un Technical Writer?

Gli studenti sono idonei a lavorare con le organizzazioni accettate, ma la stagione dei documenti di Google non è intesa a insegnare le competenze di scrittura tecnica. Prevediamo che i tecnici della scrittura partecipanti abbiano competenze professionali di scrittura tecnica o un'esperienza pertinente equivalente. Gli studenti che vogliono partecipare devono mettere in evidenza la loro esperienza di scrittura e editing pertinente quando contattano organizzazioni e progetti interessati.

Posso partecipare sia come Technical Writer a Google Season of Docs sia come studente a Google Summer of Code?

Anche se al momento non è contro le regole, consigliamo vivamente agli studenti ammessi a Google Summer of Code di non candidarsi come technical writer per Google Season of Docs. Gli studenti dovrebbero concentrarsi sul lavoro di Google Summer of Code invece di presentare domanda per Google Season of Docs.

Inoltre, la stagione dei documenti di Google non è pensata per i principianti, ma per persone che hanno già competenze ed esperienza nella scrittura tecnica di livello medio-alto. I Technical Writer che partecipano a Google Season of Docs non vengono seguiti da un mentore, ma devono essere autoorganizzati e motivati a elaborare un piano per affrontare il progetto dell'organizzazione con un'assistenza minima da parte degli amministratori dell'organizzazione e di altri membri della community.

In qualità di autore tecnico, come posso contattare gli amministratori del programma Google Season of Docs se ho altre domande o dubbi?

Puoi contattare gli amministratori del programma Google Season of Docs inviando un'email all'indirizzo season-of-docs@google.com.

Una società o una società di consulenza di scrittura tecnica può partecipare alla Stagione dei documenti di Google?

Sì, un'organizzazione può assumere una società per svolgere il lavoro descritto nella proposta.

Come faccio a fare riferimento a Google Season of Docs nel mio curriculum?

Elencala come faresti con qualsiasi altro lavoro da freelance, ad esempio "Ho lavorato come Technical Writer per [nome del progetto] nell'ambito del programma Google Season of Docs".

Fornite certificati di completamento per la partecipazione al Google Season of Docs?

Non siamo in grado di inviare certificati o conferme della partecipazione al progetto ai redattori tecnici.

Per gli amministratori delle organizzazioni open source

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

Per poter partecipare come organizzazione, devi essere un gruppo che gestisce un progetto di software libero/open source attivo, come BRL-CAD. Il progetto non deve essere un'entità giuridica costituita. Per poter partecipare al programma, le organizzazioni devono avere già prodotto e rilasciato software in base a una licenza approvata dall'Open Source Initiative e disporre di almeno due collaboratori che fungano da amministratori dell'organizzazione per l'intero programma Google Season of Docs.

Consulta anche i requisiti di idoneità descritti nelle norme del programma e nei programmi di sanzioni e informazioni sul paese del Tesoro degli Stati Uniti.

"Organizzazione" è equivalente a un progetto open source?

Un'organizzazione può avere uno o più progetti open source. Alcune organizzazioni, come le fondazioni, possono avere più organizzazioni secondarie, ciascuna con uno o più progetti open source. Se la tua organizzazione ha suborganizzazioni indipendenti, invia richieste e proposte separate per ciascuna.

Un'organizzazione può inviare più di una richiesta di proposta?

No. Invia una sola richiesta per organizzazione. Se la tua organizzazione ha organizzazioni secondarie (ad esempio, è una fondazione con molti progetti open source individuali), ogni progetto deve inviare la propria richiesta, anche se i fondi della sovvenzione verranno gestiti dall'organizzazione ombrello.

Un gruppo di progetti open source può inviare una proposta congiunta per lavorare a un singolo progetto di documentazione?

Un'organizzazione deve inviare la richiesta di proposta ed essere responsabile del coordinamento del lavoro e del supporto da parte di altri progetti partecipanti. Ad esempio, un gruppo di piccoli progetti open source che sono tutti plug-in per un progetto più grande e che vogliono lavorare a una guida pratica congiunta per la creazione di plug-in deve scegliere un'organizzazione per guidare il progetto.

In che modo la mia organizzazione riceverà i fondi?

Per ricevere i fondi, la tua organizzazione deve avere un account Open Collective.

Le organizzazioni ricevono denaro per la partecipazione a Google Season of Docs?

Le organizzazioni possono includere fondi per l'amministrazione, la mentorizzazione o la revisione del lavoro all'interno dei budget dei progetti.

Google copre le commissioni di elaborazione dei pagamenti?

Le spese di elaborazione dei pagamenti non sono coperte da Google, in quanto tendono a variare in base al metodo di pagamento. Tuttavia, Google copre la commissione della piattaforma Open Collective e, se decidi di utilizzare Open Collective come host fiscale, viene coperta anche questa commissione. Per ulteriori informazioni, consulta la guida alla ricezione dei sussidi.

Come deve la mia organizzazione prevedere il costo di un autore tecnico?

Ti consigliamo di consultare il sondaggio sugli stipendi di Write the Docs e di calcolare le tariffe orarie. Puoi anche partecipare al canale Write The Docs Slack e chiedere nel canale #season-of-docs di fare un'offerta ai technical writer interessati.

La mia organizzazione può utilizzare il contributo di Google Season of Docs per pagare un collaboratore attuale?

Sì. Tuttavia, le proposte di progetto devono riguardare nuovi lavori (inclusi lavori di manutenzione, revisione o upgrade della documentazione esistente). Non puoi richiedere una sovvenzione da utilizzare per pagare un lavoro già completato.

La mia organizzazione può collaborare con gli autori tecnici studenti?

Puoi scegliere di far lavorare gli studenti addetti alla stesura della documentazione tecnica sul tuo progetto. Se scelgono di lavorare con gli studenti, consigliamo vivamente di limitare la partecipazione agli studenti che:

  • Avere più di 18 anni
  • Sono iscritti a un programma o a un corso di scrittura tecnica o di comunicazione tecnica
  • Avere accesso dimostrabile a un programma di tutoraggio per la scrittura tecnica tramite il proprio programma o corso

La mia organizzazione può collaborare con più di un redattore tecnico?

La tua organizzazione può selezionare e pagare più di un autore tecnico, ma tutti gli autori tecnici che collaborano con la tua organizzazione devono lavorare al progetto che hai proposto. La collaborazione con più addetti alla scrittura tecnica aggiunge complessità al progetto e richiede più tempo di volontariato e amministrazione.

La mia organizzazione può assumere una società di scrittura tecnica per lavorare al nostro progetto?

Sì, la tua organizzazione può assumere una società di scrittura tecnica per lavorare al tuo progetto. Assicurati che la società che assumi possa ricevere pagamenti tramite Open Collective.

Il nostro Technical Writer si è ritirato prima della fine del programma. Possiamo ancora ricevere i fondi rimanenti?

Ti invitiamo vivamente a provare a trovare un nuovo autore tecnico per completare il tuo progetto prima della fine del programma. Tuttavia, lo sgravio dei fondi rimanenti non si basa sul completamento del progetto, ma sul completamento del caso di studio e della valutazione finale.

Se non è stato possibile completare il progetto, ci aspettiamo che il tuo caso studio esamini il motivo. Ad esempio, potresti aver riscontrato che gli strumenti di documentazione sono molto complicati e hanno rappresentato un ostacolo per l'onboarding di un autore tecnico oppure che il tuo progetto prevedeva il test e l'aggiornamento di tutorial e richiedeva una vasta esperienza di programmazione. Cosa consiglieresti ad altri progetti, in base alla tua esperienza? Includi queste informazioni nel tuo case study.

È possibile esaminare la richiesta di un'organizzazione prima della scadenza per l'invio?

Purtroppo non siamo in grado di fornire feedback sulla richiesta dell'organizzazione.

In che modo le organizzazioni devono definire l'ambito delle proposte di progetto?

Quando sviluppi idee di progetto, cerca di trovare i progetti più piccoli che forniscono valore all'organizzazione (ma che possono essere ampliati se il tempo lo consente). È preferibile un valore più basso. Quando crei la proposta di progetto, ti consigliamo di optare per progetti più piccoli e dettagliati rispetto a progetti più grandi e meno specifici. Se il tuo progetto richiede molta esperienza nel dominio, prova a includere progetti su cui potrebbe lavorare qualcuno senza queste competenze.

Posso partecipare come amministratore dell'organizzazione a Google Season of Docs e come mentor a Google Summer of Code?

Sì. Google Season of Docs e Google Summer of Code sono programmi distinti. Se hai la larghezza di banda per partecipare a entrambi i programmi, non c'è problema.

La nostra organizzazione ha partecipato a precedenti programmi della stagione dei documenti di Google. Possiamo presentare nuovamente domanda?

Sì, le organizzazioni che hanno partecipato ai programmi Google Season of Docs precedenti possono presentare nuovamente domanda.

Dati archiviati

Come faccio a rimuovere le mie informazioni dall'archivio della stagione dei documenti di Google?

Contattaci per richiedere la rimozione delle tue informazioni.