Domande frequenti

Fase attuale:
Sviluppo della documentazione. Consulta la cronologia.

Generale

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

La nostra organizzazione vorrebbe partecipare alla stagione di Documenti Google, 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 della stagione dei documenti

Scrivi Documenti Slack o sui canali dei 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 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 video è un possibile progetto per Google 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 Google Season of Docs?

Un controllo della documentazione è un ottimo progetto per Google 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?

Google Season of Docs ha un repository GitHub con un modello e un elenco di controllo per eseguire i controlli della documentazione. Altri modelli verranno aggiunti 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 Google?

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

Come faccio a ricevere aggiornamenti sulla stagione di Documenti Google?

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

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

Utilizza http://goo.gle/2NeZVew per iscriverti al calendario della stagione di Documenti Google.

Che cosa posso fare per contribuire a far conoscere Google 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 un incontro o una sessione informativa di Google Season of Docs?

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

Puoi condividere delle statistiche sui programmi del 2019 e del 2020?

Sì, i risultati della stagione dei documenti di Google relativi al programma 2019 possono essere visualizzati sul blog open source Googlel (2019, 2020).

Riceverò una maglietta per la stagione dei documenti Google?

No. A causa dei limiti di spedizione internazionali, la stagione di Google Documenti non è più in grado di fornire le magliette ai partecipanti che completano con successo il loro progetto Stagione di Documenti Google.

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 una risposta, valuta la possibilità di discutere delle tue domande con la community di Google Season of Docs presente nell'elenco di discussione. Leggi le informazioni sui canali di discussione e su come contattarci.

Come posso essere un mentore per Google Season of Docs?

La stagione dei documenti di Google 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 stagione Google Season of Docs, contatta gli amministratori della tua organizzazione per diventare volontari.

La stagione di Documenti Google è come l'estate di Google?

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

Per i Technical writer

Quando i Technical Writer possono richiedere la stagione di Documenti Google?

Google Season of Docs non ha una candidatura formale di Technical Writer. Per partecipare alla stagione di Documenti Google in qualità di Technical Writer, contatta direttamente le organizzazioni open source, seguendo le istruzioni riportate nella pagina del programma Google Season of Docs. Puoi anche esprimere il tuo interesse aggiungendoti alla directory degli scrittori tecnici di Google Season of Docs. Per ulteriori informazioni, consulta la guida per gli autori tecnici.

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

Gli strumenti di documentazione e i framework che utilizzerai dipendono dall'organizzazione con cui vuoi lavorare. Parte dell'obiettivo di Google Season of Docs è costituito dai progetti open source per aiutare i Technical Writer a conoscere meglio gli strumenti e i framework coinvolti nella documentazione dei prodotti open source. Per questo motivo, di solito non è necessario conoscere dettagliate di piattaforme di documentazione specifiche prima di iniziare il progetto Google 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 della stagione di Documenti Google?

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 Google 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 a un'organizzazione, puoi descrivere la tua esperienza o l'eventuale formazione che hai ricevuto in ambito tecnico. 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 di cui l'organizzazione ha bisogno per garantire il completamento efficace dei loro progetti Google Season of Docs.

Riceverò un compenso per la partecipazione alla stagione di Documenti Google?

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 Google?

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 eseguire il commit, dovresti valutare il progetto e discutere di 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. Se ti interessa partecipare come parte di un progetto, contattalo e collabora a una proposta di candidatura.

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

Gli studenti possono lavorare con le organizzazioni accettate, ma la stagione dei documenti Google non è pensata per insegnare competenze di scrittura tecnica. Gli autori tecnici partecipanti devono avere competenze di scrittura tecnica professionale o un'esperienza pertinente equivalente. Gli studenti che vogliono partecipare devono mettere in evidenza la propria esperienza di scrittura e modifica.

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

I nuovi collaboratori o studenti accettati per Google Summer of Code sono scoraggiati dal fare domanda per diventare Technical Writer di Google Season of Docs.

Google Season of Docs non è pensata per i principianti, ma si rivolge a persone che hanno già solide o ottime capacità di scrittura tecnica. I Technical writer nella stagione di Documenti Google non vengono offerti da mentori, ma devono essere organizzati in modo autonomo 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 scrittura tecnica o una società di consulenza possono partecipare alla stagione di Documenti Google?

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

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

Elencalo come faresti con qualsiasi altra opera freelance: "Ha lavorato come Technical Writer per [nome progetto] nell'ambito del programma Google Season of Docs."

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

Google Season of Docs non è in grado di inviare certificati o conferme di 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 o 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'intero programma della stagione di Documenti Google.

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 l'organizzazione ha organizzazioni secondarie indipendenti, invia applicazioni e proposte separate per ciascuna di queste.

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 stagione di Documenti Google?

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

Google copre le commissioni per l'elaborazione dei pagamenti?

Le commissioni per l'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, viene coperta anche questa tariffa. Per ulteriori informazioni, consulta la guida relativa alla ricezione delle concessioni.

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 di Documenti Google per pagare un collaboratore attuale?

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

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. La nostra organizzazione è ancora idonea a ricevere i fondi rimanenti?

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

Se non è stato possibile completare il progetto, il tuo case study dovrebbe esaminarne 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. Che 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 Google Season of Docs non è in grado di fornire feedback sull'applicazione 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 Google Season of Docs e come mentore a Google Summer of Code?

Sì. Google 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 c'è problema.

La nostra organizzazione ha partecipato ai precedenti programmi della stagione dei documenti Google. La nostra organizzazione può presentare nuovamente domanda?

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

Dati archiviati

Come faccio a rimuovere le mie informazioni dall'archivio di Google Season of Docs?

Contattaci per richiedere la rimozione dei tuoi dati.