Guida tecnica per autori

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

Questa guida è rivolta ai redattori tecnici interessati a collaborare con le organizzazioni accettate nel programma Google Season of Docs 2021.

Dovresti partecipare al programma Stagione di Documenti Google 2021?

Utilizza queste domande per capire se ti interessa collaborare con un'organizzazione accettata nel programma Google Season of Docs 2021.

  • Hai esperienza e competenze di scrittura tecnica? Season of Docs non intende insegnare competenze di base di scrittura tecnica. Hai un atteggiamento motivato e organizzato?
  • Hai tempo di partecipare durante i sei mesi del programma (aprile-novembre 2021)? Le dimensioni dei progetti variano, ma vanno da un impegno di 5-30 ore a settimana durante il programma.
  • Ti interessa acquisire esperienza nell'open source? Sei disposto a dedicare del tempo all'apprendimento delle procedure e delle norme della community di un progetto?
  • Sei disposto a collaborare con l'amministratore dell'organizzazione per perfezionare le proposte di progetto, sviluppare tempistiche, valutare e compilare metriche e aiutare l'organizzazione nel suo complesso a comprendere il valore della scrittura tecnica?

Inoltre, devi soddisfare i requisiti di idoneità del programma, tra cui la possibilità di creare un account Open Collective. Tieni presente che devi disporre legalmente dei fondi per il lavoro svolto nel tuo luogo di residenza. Gli amministratori del programma Stagione di Documenti non sono in grado di fornire consulenza fiscale o rispondere a domande sulla tua idoneità al lavoro.

In qualità di scrittore tecnico esperto che partecipa a Google Season of Docs, riceverai un compenso per acquisire esperienza lavorando in open source e aiutare il tuo progetto a risolvere un'esigenza fondamentale tramite documenti migliori.

Partecipazione al programma Season of Docs 2021 come Technical Writer

Fase di esplorazione

Le domande di partecipazione delle organizzazioni si chiuderanno il 26 marzo 2021 alle ore 18:00 UTC. Consigliamo ai Technical Writer di iniziare a esplorare i possibili progetti il prima possibile. Tuttavia, le organizzazioni possono selezionare i redattori tecnici con cui collaborare in qualsiasi momento prima delle 18:00 UTC del 17 maggio 2021.

  • Trova i progetti che ti interessano
    • Contatta direttamente le organizzazioni open source seguendo le istruzioni riportate nella pagina del programma Google Season of Docs o consulta il repository GitHub di Google Season of Docs per trovare le organizzazioni che hanno espresso il proprio interesse a partecipare a Google Season of Docs. Puoi anche trovare organizzazioni interessate nel canale #season-of-docs del canale Slack di Write the Docs.
    • Ecco alcuni modi per scegliere un progetto:
      • Scegli un progetto in un linguaggio che conosci o che ti interessa, ad esempio JavaScript o C.
      • Scegli un progetto in una tecnologia o un dominio che ti interessa, ad esempio machine learning, open science o robotica.
      • Scegli un progetto in base alla cordialità della community. Frequenta i loro forum di discussione, dai un'occhiata agli account dei collaboratori sui social media (se parlano del loro progetto lì) e controlla la documentazione di onboarding, se disponibile.
      • Se un progetto con cui vorresti lavorare non è nell'elenco, contattalo e chiedigli di valutare la possibilità di presentare domanda.
  • Esamina le pagine delle proposte dei progetti
    • Quando hai dai 3 ai 5 progetti possibili, consulta la pagina della proposta di ciascun progetto
    • Dovresti porre domande, fornire feedback e dare suggerimenti utilizzando i canali elencati nel progetto per ricevere feedback e discussioni
  • Invia una dichiarazione di interesse direttamente all'organizzazione. Nella dichiarazione di interesse mostrerai come raggiungeresti gli obiettivi stabiliti nella proposta di progetto dell'organizzazione.
    • Utilizza il modello di dichiarazione di interesse per la Stagione dei documenti di Google. Più breve è, meglio è.
    • Segui le istruzioni riportate nella pagina delle idee dell'organizzazione per inviare la tua dichiarazione di interesse. Se l'organizzazione ha elencato requisiti speciali, assicurati di dimostrare di soddisfarli nella tua dichiarazione.
    • Inviando la tua dichiarazione di interesse, accetti di rispettare il codice di condotta dell'organizzazione e il codice di condotta della Stagione di Documenti.

Fase di applicazione

  • Attendi l'annuncio delle organizzazioni accettate da Google per la Season of Docs:
    • Le organizzazioni accettate ti contatteranno direttamente se vogliono collaborare con te o discutere ulteriormente della tua dichiarazione di interesse.
    • Le organizzazioni non sono limitate a collaborare solo con i redattori tecnici che hanno inviato dichiarazioni di interesse entro la scadenza delle domande dell'organizzazione. Potrebbero richiedere ulteriori dichiarazioni di interessi dopo l'accettazione. Le organizzazioni devono selezionare un autore tecnico prima delle 18:00 UTC del 17 maggio 2021.
    • Le organizzazioni non sono tenute a fornire feedback sulle dichiarazioni di interesse non andate a buon fine.

Fase di sviluppo del progetto

  • Collabora con l'organizzazione per creare un programma, inclusi gli adempimenti e le scadenze.

Fase di valutazione finale e case study

  • Collabora con l'organizzazione per fornire le informazioni necessarie per la valutazione finale e il caso di studio.