Guida tecnica per autori

Fase attuale:
Sono stati annunciati i risultati. Consulta la cronologia.

Questa guida è pensata per i Technical Writer interessati a collaborare con le organizzazioni accettate nel programma Google Season of Docs.

È meglio partecipare al programma Google Season of Docs?

Queste domande ti aiuteranno a capire se ti potrebbe interessare collaborare con un'organizzazione accettata nel programma Google Season of Docs.

  • Hai competenze ed esperienza tecnica in scrittura? La stagione di Google Documenti non è pensata per insegnare competenze tecniche di scrittura di base. Sei motivato e organizzato?
  • Hai tempo per partecipare ai sei mesi del programma? Le dimensioni dei progetti variano, ma vanno da un impegno di 5-30 ore a settimana durante il programma.
  • Ti interessa fare esperienza nel lavoro open source? Sei disponibile a dedicare tempo all'apprendimento dei processi e delle norme comunitarie di un progetto?
  • Sei disponibile a collaborare con l'amministratore dell'organizzazione per perfezionare le proposte di progetto, sviluppare le tempistiche, valutare e compilare metriche e aiutare l'organizzazione a comprendere il valore della scrittura tecnica nel suo insieme?

Devi inoltre soddisfare i requisiti di idoneità del programma, inclusa la possibilità di creare un account Open Collective. Tieni presente che devi essere legalmente in grado di ricevere fondi per il lavoro svolto nel tuo luogo di residenza. Gli amministratori del programma Season of Docs non sono in grado di fornire consulenza fiscale o rispondere a domande sulla tua idoneità lavorativa.

In qualità di Technical Writer esperto che partecipa alla stagione di Documenti Google, ti ricompenserai per acquisire esperienza nel lavoro open source e aiutare il tuo progetto a risolvere un'esigenza fondamentale mediante documenti migliori.

Partecipare al programma Google Season of Docs in qualità di Technical Writer

Fase di esplorazione

Le candidature dell'organizzazione chiudono il 24 marzo 2023 alle 18:00 UTC. Consigliamo agli autori tecnici di iniziare a esplorare i possibili progetti il prima possibile. Tuttavia, le organizzazioni possono scegliere i Technical Writer con cui collaborare in qualsiasi momento prima del 10 maggio 2023 alle 18:00 UTC.

  • Trova i progetti che ti interessano.
    • Contatta direttamente le organizzazioni open source utilizzando le istruzioni nella pagina del programma Google Season of Docs o consulta il repository GitHub della stagione dei documenti di Google per trovare le organizzazioni che hanno espresso interesse a partecipare alla stagione di Documenti Google. Puoi anche trovare le organizzazioni che ti interessano sul canale #season-of-docs nella pagina Write the Docs Slack.
    • 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 in un dominio che ti interessa, ad esempio machine learning, scienze aperte o robotica.
      • Scegli un progetto basato sull'affetto della community! Partecipare ai loro forum di discussione, controllare gli account social media dei collaboratori (se parlano del loro progetto) e consultare la loro documentazione per l'onboarding, se presente.
      • Se vuoi lavorare con un progetto che non è presente nell'elenco, contattalo e chiedi di prendere in considerazione l'idea di presentare domanda.
  • Esamina le pagine delle proposte relative ai progetti.
    • Quando hai 3-5 progetti possibili, consulta la pagina della proposta di ogni progetto
    • Ti consigliamo di porre domande, fornire feedback e fornire suggerimenti utilizzando i canali elencati nel progetto per fornire feedback e discussioni.
  • Invia una dichiarazione di interesse direttamente all'organizzazione. Nella tua dichiarazione d'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 dei requisiti speciali, assicurati di dimostrare di soddisfarli nel tuo estratto conto.
    • Inviando la tua dichiarazione di interesse, accetti di rispettare il codice di condotta dell'organizzazione e il codice di condotta della stagione di Google Documenti.

Fase di applicazione

  • Attendi l'annuncio delle organizzazioni accettate da parte di Google Season of Docs:
    • Le organizzazioni accettate ti contatteranno direttamente se vorranno collaborare con te o discutere ulteriormente della tua dichiarazione di interesse.
    • Le organizzazioni non si limitano a lavorare solo con i Technical Writer che hanno inviato dichiarazioni di interesse entro la scadenza della relativa domanda di partecipazione. Possono richiedere ulteriori dichiarazioni di interesse dopo l'accettazione. Le organizzazioni devono selezionare un Technical Writer prima del 10 maggio 2023 alle 18:00 UTC.
    • Le organizzazioni non sono tenute a fornire feedback in merito a dichiarazioni di interesse non andate a buon fine.

Fase di sviluppo del progetto

  • Collabora con l'organizzazione per creare un programma, inclusi i risultati finali e le scadenze.

Valutazione finale e fase del case study

  • Collabora con l'organizzazione per fornire le informazioni necessarie per la valutazione finale e il case study.