Domande frequenti

Fase attuale:
Il programma Stagione di Documenti 2021 si è concluso il 14 dicembre 2021. Consulta la cronologia.

Generale

Season of Docs è un programma di selezione del personale?

No. Se ti interessa lavorare per Google, visita il sito web delle offerte di lavoro di Google.

Quali sono le modifiche alla stagione di Documenti 2021?

La stagione di Documenti 2021 è stata modificata in modo significativo rispetto agli anni precedenti, tra cui:

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

Perché Season of Docs ha apportato queste modifiche?

La missione di Google è organizzare le informazioni a livello mondiale e renderle universalmente accessibili e utili. Ripensando la stagione di Documenti per enfatizzare 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 alla stagione 2021 di Documenti, ma non sappiamo da dove iniziare.

Consulta il nostro elenco completo di idee per progetti. Puoi anche rivolgerti alla community dei redattori tecnici (prova il canale #season-of-docs in Write the Docs Slack o sui canali dei social media per chiedere assistenza o 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, poi pubblica un insieme iniziale di documenti di base sul sito. Esempi di piattaforme includono:

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

  • Scrivi una panoramica concettuale o un'introduzione a un prodotto o a 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 questo 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 a collaborare al progetto open source, nonché tutte le regole relative ai contratti di licenza, alle procedure per le richieste di pull e alle revisioni, alla creazione del progetto e così via.

È un possibile progetto per Season of Docs?

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

Un controllo della documentazione è un progetto ragionevole per Season of Docs?

Un controllo della documentazione è un ottimo progetto per Season of Docs. Fai attenzione a quanta documentazione hai già. Se ne hai tanta, potresti dover ridurre l'ambito (ad esempio, semplicemente controllando i contenuti dei tutorial). Se hai poca o nessuna documentazione, ti consigliamo di includere nel tuo progetto la creazione della documentazione mancante con la massima priorità.

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 i 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 validi per l'open source.

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

No. A volte, i progetti non vengono visualizzati come previsto o i requisiti cambiano. Non richiediamo 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?

Season of Docs avviene interamente online. Non è necessario viaggiare.

Come faccio a ricevere aggiornamenti sulla stagione di Documenti?

Consulta la mailing list per l'annuncio 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 cronologia della stagione di Documenti al mio calendario?

Sì, puoi aggiungerlo tramite questo link.

Che cosa posso fare per contribuire a spargere la voce su Season of Docs?

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

Come faccio a organizzare o organizzare una sessione di informazioni o un incontro con la stagione di Documenti?

Puoi fissare un appuntamento per partecipare quando e dove preferisci. Consulta le regole del programma e utilizza i contenuti di esempio.

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

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

Riceverò una maglietta per la stagione dei documenti?

No, a causa di vincoli di spedizione internazionali, non saremo più in grado di fornire magliette ai partecipanti che completano con successo il loro progetto Stagione di Documenti.

A chi mi rivolgo se avessi altre domande?

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

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

Come posso essere un mentore per Season of Docs?

La stagione 2021 dei documenti non ha un ruolo di mentore formale. Le organizzazioni devono specificare in che modo i Technical Writer verranno inseriti e supportati e in che modo i loro contributi alla documentazione verranno esaminati e approvati nell'ambito della candidatura 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 il Summer of Code di Google?

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

Per i Technical writer

Quando i Technical Writer possono richiedere la partecipazione a Season of Docs?

La stagione 2021 di Documenti non prevede una candidatura formale di Technical Writer. Per partecipare alla stagione 2021 di Documenti in qualità di Technical Writer, contatta direttamente le organizzazioni open source, utilizzando le istruzioni nella relativa pagina del programma Stagione di Documenti. Puoi anche esprimere il tuo interesse aggiungendoti alla directory Technical Writer (Season of Docs). Per ulteriori informazioni, consulta la guida per gli autori tecnici.

Quali strumenti di documentazione e framework devo conoscere per partecipare a Season of Docs?

Gli strumenti di documentazione e i framework che utilizzerai dipendono dall'organizzazione con cui vuoi lavorare. Parte dell'obiettivo di Season of Docs è costituito dai progetti open source per aiutare i Technical Writer a saperne di più sugli strumenti e sui framework coinvolti nella documentazione dei prodotti open source. Per questo motivo, di solito non è obbligatorio 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 tipo 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 di acquisire familiarità con la sintassi. Markdown è un buon punto di partenza, perché i file README GitHub utilizzano una versione di Markdown. Consulta la guida di GitHub per 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, ad esempio Jekyll, Sphinx o Hugo, oppure l'organizzazione può ospitare i propri documenti su Leggi i documenti o Pagine GitHub. Una volta determinata la piattaforma utilizzata dall'organizzazione, esplora e sperimenta il linguaggio e il framework pertinenti. Questo ti consente di iniziare rapidamente a lavorare al tuo progetto open source e di essere in grado di fornire consigli audio al progetto open source di tua scelta.

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

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

È possibile che i Technical writer che stanno già lavorando a un progetto open source possano continuare a lavorarci nell'ambito di Season of Docs?

Sì, ma l'organizzazione deve indicare nella proposta la relazione precedente o continuativa dell'autore tecnico 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 in scrittura o formazione tecnica in precedenza. Quando invii una dichiarazione di interesse per un'organizzazione, puoi descrivere la tua esperienza e/o la tua formazione in 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à tecnici tecnici con il livello di esperienza necessario per l'organizzazione per garantire il completamento ottimale dei loro progetti della stagione di Documenti.

Riceverò un pagamento per la partecipazione alla Season of Docs?

Sì. Google fornirà sovvenzioni alle organizzazioni accettate per assumere professionisti tecnici.

Come si presenta una buona dichiarazione di interesse per un redattore tecnico?

Le migliori dichiarazioni di interesse provengono dai Technical writer che dedicano il tempo a interagire con e discutere le proprie idee con l'organizzazione open source scelta prima di inviare le dichiarazioni. Consulta la guida per creare la tua dichiarazione di interesse.

Quanto tempo richiede la partecipazione alla stagione di 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 procedere, valuta il progetto e discuti una stima del tempo con l'organizzazione open source.

Posso inviare una richiesta dell'organizzazione per creare la 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 del progetto o non ne contribuisco.

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 candidatura.

Sono uno studente, soddisfo i requisiti di idoneità per partecipare alla stagione 2021 di Documenti? Season of Docs mi insegnerà a fare tecnico?

Gli studenti possono lavorare con organizzazioni accettate, ma Season of Docs non è pensata per insegnare competenze di scrittura tecnica. Ci aspettiamo che gli autori tecnici partecipanti abbiano competenze di scrittura tecnica professionale o esperienza pertinente equivalente. Gli studenti che vogliono partecipare devono assicurarsi di mettere in evidenza la propria esperienza di scrittura e modifica pertinente 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, consigliamo vivamente agli studenti che hanno accettato di partecipare a Google Summer of Code non fare domanda per diventare scrittore tecnico di Season of Docs. Gli studenti dovrebbero concentrarsi sul lavoro Summer of Code di Google anziché fare domanda per la Season of Docs.

Inoltre, Season of Docs non è pensata per i principianti, ma per persone che hanno già solide o ottime capacità di scrittura tecnica. I Technical writer nella Season of Docs non hanno un mentore, 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 Season of Docs in caso di ulteriori domande o dubbi?

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

Un'azienda di scrittura tecnica o una società di consulenza possono partecipare a Season of Docs?

Sì, un'organizzazione può assumere un'azienda per svolgere le operazioni 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 "Ha lavorato come Technical writer per [nome progetto] nell'ambito del programma Season of Docs".

Fornisci certificati di completamento per la partecipazione alla stagione di Documenti?

Non siamo in grado di inviare certificati o conferme della partecipazione al progetto ai Technical Writer.

Per gli amministratori dell'organizzazione open source

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

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

Consulta anche i requisiti di idoneità descritti nelle regole del programma e le informazioni sui programmi sulle sanzioni e sui paesi 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 che hanno uno o più progetti open source. Se la tua organizzazione ha organizzazioni secondarie indipendenti, invia applicazioni e proposte separate per ciascuna organizzazione secondaria.

Un'organizzazione può presentare più di una richiesta 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 singoli progetti open source), 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 insieme una proposta 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 a una guida illustrativa congiunta per la creazione di plug-in dovrebbe scegliere un'organizzazione che dirige il 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 Season of Docs?

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

Quale deve essere il budget destinato a un Technical Writer per la mia organizzazione?

Ti consigliamo di consultare Scrivere il sondaggio sugli stipendi di Documenti e calcolare le tariffe orarie. Puoi anche unirti a Write The Docs Slack e chiedere sul canale #season-of-docs gli autori tecnici interessati a presentare un'offerta.

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

Sì. Tuttavia, le proposte di progetto devono riguardare il nuovo lavoro (inclusi gli interventi di manutenzione, revisioni o upgrade della documentazione esistente). Non puoi richiedere una sovvenzione 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 corso di scrittura tecnica o comunicazione tecnica
  • Hanno accesso dimostrabile al tutoraggio nella 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 che proponi. La collaborazione con più Technical Writer aggiungerà più complessità al tuo progetto e richiederà 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 potrebbe assumere una società di scrittura tecnica affinché svolga il tuo progetto. Assicurati che l'azienda che assumi possa ricevere i pagamenti tramite Open Collective.

Il nostro Technical Writer ha abbandonato prima della fine del programma. Siamo ancora idonei a 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 il progetto non è stato completato, ci aspettiamo che il case study esamini il motivo. Ad esempio, potresti aver scoperto che i tuoi strumenti di documentazione sono molto complicati e si sono dimostrati un ostacolo all'onboarding di un Technical writer o che il tuo progetto prevedeva test e aggiornamenti 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.

La domanda di un'organizzazione può essere esaminata prima della scadenza di invio?

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

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

Quando sviluppi le idee per i progetti, cerca di trovare i progetti più piccoli che daranno valore all'organizzazione (ma che possono essere ampliati se il tempo lo consente). Minore è il valore, meglio è. Quando crei la tua proposta di progetto, ti consigliamo di concentrarti su progetti più piccoli e più dettagliati rispetto a progetti più grandi e meno specificati. Se il tuo progetto richiede un'ampia esperienza in ambito ambito, prova a includere progetti su cui potrebbe essere elaborata una persona senza quell'esperienza.

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

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

La nostra organizzazione ha partecipato ai precedenti programmi Season of Docs. Possiamo presentare nuovamente domanda?

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

Dati archiviati

Come faccio a rimuovere i miei dati dall'archivio Season of Docs?

Contattaci per richiedere la rimozione dei tuoi dati.