Domande frequenti

Fase attuale:
Risultati annunciati tempistiche.

Generale

Season of Docs è un programma di selezione del personale?

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 2019 e 2020?

L'attuale programma Stagione dei documenti ha subito cambiamenti significativi rispetto agli anni precedenti, tra cui:

  • I Technical Writer non fanno più domanda tramite Google per trovare corrispondenze con le organizzazioni
  • Le organizzazioni inviano proposte di progetto, inclusi un budget e le metriche proposte,
  • Le organizzazioni accettate ricevono sovvenzioni, che utilizzano per pagare i Technical Writer
  • Le organizzazioni inviano valutazioni finali e case study

Perché la Stagione di Documenti ha apportato queste modifiche?

La missione di Google è organizzare le informazioni a livello mondiale e renderle universalmente accessibili e utili. Riorientando la Stagione di Documenti per enfatizzare l'apprendimento di pratiche di documentazione efficaci nell'open source, speriamo di avere un impatto maggiore nel lungo termine.

La nostra organizzazione vorrebbe partecipare alla stagione di Documenti, ma non sappiamo da dove iniziare.

Consulta il nostro elenco completo di idee per progetti. Puoi anche contattare la community di Technical Writer (prova il canale #season-of-docs in Write the Docs Slack o sui tuoi canali sui social media per chiedere aiuto o presentare delle proposte).

Quali tipi di progetti possono proporre le organizzazioni?

Ecco alcuni esempi:

  • Crea un sito di documentazione su una piattaforma scelta dal Technical Writer e dall'organizzazione open source, quindi 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ì. Assicurati che l'ambito dei requisiti video sia adeguato e tieni presente che la produzione di video di alta qualità richiede molto tempo e risorse.

Un controllo della documentazione è un progetto ragionevole per la stagione dei documenti?

Un controllo della documentazione è un ottimo progetto per Season of Docs. Fai attenzione a quanta documentazione hai già; se ne hai molta, potresti dover ridurre l'ambito (ad esempio, semplicemente verificando i contenuti del tutorial). Se non disponi di documentazione o se non disponi di documentazione, ti consigliamo di includere la creazione della documentazione mancante con la massima priorità nell'ambito del tuo progetto.

Sono disponibili modelli di documentazione che le organizzazioni e i Technical Writer possono utilizzare?

Season of Docs ha un repository GitHub con un modello e un elenco di controllo per eseguire controlli della documentazione. Speriamo di aggiungere altri modelli man mano che vengono creati.

The Good Docs Project è al lavoro per creare alcuni modelli di documentazione minimi funzionanti per l'open source.

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

No. A volte, i progetti non vengono restituiti 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 case study includano una discussione sul motivo per cui la documentazione non è stata utilizzata e sul modo in cui il progetto ha preso la decisione di non utilizzare la documentazione o altri materiali.

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.

Posso aggiungere la sequenza temporale della stagione dei documenti al mio calendario?

Sì, puoi aggiungerlo tramite questo link.

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.

Esistono statistiche che puoi condividere sulle stagioni di Documenti del 2019 e del 2020?

Sì, i risultati della stagione dei documenti relativi al programma 2019 sono disponibili qui e i risultati del programma 2020 sono disponibili qui.

Riceverò una maglietta per la stagione dei documenti?

No, a causa dei vincoli di spedizione internazionale, non saremo più in grado di fornire T-shirt ai partecipanti che completano correttamente il progetto per la stagione dei documenti.

A chi mi rivolgo se avessi altre domande?

Dai un'occhiata alla guida per l'amministratore dell'organizzazione e alla guida per gli autori tecnici.

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 nell'elenco di discussione. Consulta le informazioni sui canali di discussione e su come contattarci.

Come posso essere un mentore per la stagione dei documenti?

La stagione di Documenti non ha un ruolo formale di mentore. Le organizzazioni devono specificare le modalità di onboarding e supporto dei Technical Writer 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 ai Technical Writer nell'ambito della Season of Docs, ti invitiamo a collaborare con gli amministratori della tua organizzazione come volontario.

È la stagione dei documenti come l'estate di Google?

No. La stagione di Documenti è destinata a persone con una certa esperienza di scrittura tecnica, non è pensata come un programma di tutoraggio come Google Summer of Code.

Per i Technical Writer

Quando i Technical Writer possono richiedere la stagione di Documenti?

La stagione di Documenti non prevede una richiesta di Technical writer formale. Per partecipare alla Season of Docs in qualità di Technical Writer, contatta direttamente le organizzazioni open source seguendo le istruzioni riportate nella pagina del programma Stagione di Documenti. Puoi anche esprimere il tuo interesse aggiungendoti alla Directory degli scrittori tecnici della stagione di Documenti. Per ulteriori informazioni, consulta la guida per gli autori 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 della Stagione di Documenti è creare 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 di 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. Quando 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 ai progetti per la stagione dei documenti?

A seconda della natura del progetto di documentazione, potrebbe essere necessario avere familiarità con 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.

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

Sì, ma l'organizzazione deve indicare nella proposta il rapporto precedente o continuativo del Technical Writer con il progetto.

Quali sono i requisiti di idoneità per partecipare?

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 dichiarazione di interesse a un'organizzazione, puoi descrivere la tua esperienza e/o la tua formazione in redazione tecnica. Dovresti essere in grado di fornire alcune prove che dimostrano il tuo interesse per la documentazione tecnica o la documentazione open source, inclusi esempi della documentazione scritta. L'organizzazione open source cercherà tecnici writer con il livello di esperienza necessario all'organizzazione per garantire il completamento dei progetti della stagione di Documenti.

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

Sì. Google fornirà alle organizzazioni accettate sovvenzioni da utilizzare per assumere Technical Writer.

Che aspetto ha una buona dichiarazione di interesse da parte di un Technical Writer?

Le migliori dichiarazioni di interesse provengono da tecnici che si dedicano a interagire con le proprie idee e discutono le proprie idee con l'organizzazione open source scelta prima di presentare le dichiarazioni. Consulta la guida alla creazione della dichiarazione di interesse.

Quanto tempo richiede la partecipazione alla stagione dei documenti?

Le dimensioni dei progetti variano, ma vanno da un impegno di 5-30 ore a settimana durante il programma. Tuttavia, la quantità di tempo che dedichi dipende dalla natura del progetto concordato con la tua organizzazione. Prima di impegnarti, dovresti valutare il progetto e discutere una stima del tempo con l'organizzazione open source.

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

No, dovresti inviare una proposta solo se sei in grado di ricevere fondi per conto del progetto open source. Ti invitiamo a contattare il progetto e collaborare a una proposta di candidatura.

Sono uno studente, posso partecipare alla stagione di Documenti? Season of Docs mi insegnerà a fare lo scrittore tecnico?

Gli studenti possono lavorare con organizzazioni accettate, ma Season of Docs non è pensata per insegnare competenze di scrittura tecnica. Ci aspettiamo che i Technical Writer partecipanti abbiano competenze di redazione tecnica professionale o un'esperienza pertinente equivalente. Gli studenti che vogliono partecipare devono mettere in evidenza la loro esperienza di scrittura e modifica quando contattano le organizzazioni e i progetti interessati.

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

Anche se al momento ciò non è contro le regole, suggeriamo vivamente agli studenti accettati di partecipare al programma Google Summer of Code di non richiedere il ruolo di Technical Writer per la stagione dei documenti. Gli studenti dovrebbero concentrarsi sul lavoro di Google Summer of Code anziché fare domanda per la stagione dei documenti.

Inoltre, Season of Docs non è pensata per i principianti, ma si rivolge a persone che hanno già solide o grandi capacità di scrittura tecnica. I Technical writer nella stagione dei documenti non vengono seguiti da mentori, ma devono essere organizzati e motivati a elaborare un piano per affrontare il progetto dell'organizzazione con una guida minima da parte degli amministratori dell'organizzazione e di altri membri della community.

In qualità di Technical writer, come posso contattare gli amministratori del programma Google per la stagione dei documenti in caso di ulteriori domande o dubbi?

Puoi contattare gli amministratori del programma Google per la stagione dei documenti inviando loro un'email all'indirizzo season-of-docs@google.com.

Un'azienda di redazione tecnica o una società di consulenza possono partecipare alla stagione di Documenti?

Sì, un'organizzazione può assumere un'azienda per svolgere le attività descritte nella proposta.

Come faccio a fare riferimento alla stagione dei documenti nel mio curriculum?

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

Fornisci i certificati di completamento per la partecipazione alla stagione dei documenti?

Non siamo in grado di inviare certificati o conferme di partecipazione ai progetti ai Technical Writer.

Per gli amministratori di organizzazioni open source

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

Per poter partecipare come organizzazione, 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 partecipare al programma, le organizzazioni devono aver già prodotto e rilasciato software con una licenza approvata dall'Open Source Initiative e avere almeno due collaboratori che fungano da amministratori dell'organizzazione 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.

"organizzazione" è equivalente a un progetto open source?

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

Un'organizzazione può presentare più di una domanda di proposta?

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

Un gruppo di progetti open source può inviare una proposta insieme per lavorare su un unico progetto di documentazione?

Un'organizzazione deve presentare la candidatura ed essere responsabile del coordinamento del lavoro e del supporto degli altri progetti partecipanti. Ad esempio, un gruppo di piccoli progetti open source che sono tutti plug-in per un progetto più grande che vogliono lavorare su una guida illustrativa congiunta per la creazione di plug-in, deve scegliere un'organizzazione come guida del progetto.

In che modo la mia organizzazione riceverà i fondi?

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

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

Le organizzazioni possono includere fondi per l'amministrazione, il tutoraggio o la revisione del lavoro come parte dei budget del progetto.

Google copre le spese di elaborazione dei pagamenti?

Le commissioni di elaborazione dei pagamenti non sono coperte da Google, in quanto tendono a variare in base al metodo di pagamento. Tuttavia, Google copre la tariffa della piattaforma Open Collective e, se decidi di utilizzare Open Collective come host fiscale, è coperta anche questa tariffa. Consulta la guida per la ricezione delle concessioni per ulteriori informazioni.

Come deve la mia organizzazione a definire il budget per il lavoro di un Technical Writer?

Ti consigliamo di consultare il sondaggio sugli stipendi di Documenti e di calcolare le tariffe orarie. Puoi anche unirti al programma Write The Docs Slack e chiedere al canale #season-of-docs in modo che i tecnici interessati possano fare offerte.

La mia organizzazione può utilizzare la concessione per la stagione dei documenti per pagare un collaboratore attuale?

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

La mia organizzazione può collaborare con i Technical Writer?

Puoi scegliere di far lavorare al tuo progetto degli studenti Technical Writer. Se scegli di lavorare con gli studenti, ti consigliamo vivamente di limitare la partecipazione agli studenti che:

  • Hanno più di 18 anni
  • Sono iscritti a un corso o a un programma di scrittura tecnica o comunicazione tecnica.
  • Hanno accesso dimostrabile al tutoraggio in scrittura tecnica tramite il loro programma o corso.

La mia organizzazione può collaborare con più di un Technical Writer?

La tua organizzazione può selezionare e pagare più di un Technical Writer, ma tutti i Technical Writer che lavorano con la tua organizzazione devono lavorare al progetto proposto. Lavorare con più Technical Writer renderà più complesso il progetto e richiederà più tempo di volontariato e di amministrazione.

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

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

Il nostro Technical Writer ha abbandonato il programma prima della fine. Possiamo ancora ricevere i fondi rimanenti?

Ti consigliamo vivamente di cercare un nuovo Technical Writer per completare il progetto prima della fine del programma. Tuttavia, il pagamento dei fondi residui non si basa sul completamento del progetto, ma sul completamento del case study e della valutazione finale.

Se non è stato possibile completare il progetto, ci aspettiamo che il tuo case study esamini i motivi. Ad esempio, potresti aver scoperto che i tuoi strumenti di documentazione sono molto complicati e hanno dimostrato un ostacolo all'onboarding di un Technical Writer oppure che il tuo progetto prevedeva test e aggiornamenti di tutorial e richiedeva un'ampia esperienza di programmazione. In base alla tua esperienza, che cosa consiglieresti ad altri progetti? Includi queste informazioni nel tuo case study.

È possibile esaminare la domanda 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 le idee per i progetti, cerca di individuare i progetti più piccoli che daranno valore all'organizzazione (ma possono essere ampliati se il tempo lo consente). Più piccola è, meglio è. Quando crei la proposta di progetto, ti consigliamo di scegliere progetti più piccoli e più dettagliati rispetto a progetti più grandi e meno specificati. Se il tuo progetto richiede molta esperienza in questo campo, prova a includere progetti su cui potrebbe essere lavorato qualcuno senza quel background.

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

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.

La nostra organizzazione ha partecipato ai precedenti programmi relativi alla stagione dei documenti. Possiamo presentare nuovamente domanda?

Sì, le organizzazioni che hanno partecipato ai precedenti programmi della stagione di Documenti possono presentare nuovamente domanda.

Dati archiviati

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

Contattaci per richiedere la rimozione delle tue informazioni.