Guida tecnica per autori

Fase attuale:
Risultati annunciati tempistiche.

Questa guida è rivolta ai tecnici interessati a lavorare con le organizzazioni accettate che partecipano al programma Season of Docs.

È meglio partecipare al programma Season of Docs?

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

  • Hai competenze ed esperienza tecnica di scrittura? La funzionalità Season of Docs non è pensata per insegnare competenze di scrittura tecnica di base. Sei motivato e organizzato?
  • Hai tempo per partecipare durante i sei mesi del programma? Le dimensioni dei progetti variano, ma vanno da 5 a 30 ore alla settimana durante il programma.
  • Ti interessa acquisire esperienza di lavoro nell'open source? Sei disponibile a dedicare del tempo all'apprendimento dei processi e delle norme comunitarie di un progetto?
  • Sei disponibile a lavorare con l'amministratore dell'organizzazione per perfezionare le proposte di progetto, sviluppare le tempistiche, valutare e compilare le metriche e aiutare l'organizzazione nel suo complesso a comprendere il valore della scrittura tecnica?

Devi inoltre soddisfare i requisiti di idoneità del programma, tra cui 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à al lavoro.

In qualità di Technical Writer esperto e partecipare a Season of Docs, riceverai un compenso per acquisire esperienza nel lavoro open source e potrai aiutare il tuo progetto a soddisfare un'esigenza fondamentale mediante documenti migliori.

Partecipazione al programma Season of Docs in qualità di Technical writer

Fase di esplorazione

Le candidature dell'organizzazione terminano il 25 marzo 2022 alle 18:00 UTC. Consigliamo ai Technical Writer di iniziare a esplorare possibili progetti il prima possibile. Tuttavia, le organizzazioni possono selezionare i Technical Writer con cui collaborare in qualsiasi momento prima del 16 maggio 2022 alle 18:00 UTC.

  • Trova i progetti che ti interessano
    • Contatta direttamente le organizzazioni open source utilizzando le istruzioni riportate nella pagina del programma Season of Docs, oppure consulta il repository GitHub di Season of Docs per trovare organizzazioni che hanno espresso interesse a partecipare a Season of Docs. Puoi anche trovare le organizzazioni interessate nel canale #year-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 di tuo interesse, ad esempio machine learning, scienza aperta o robotica.
      • Scegli un progetto basato sulla cordialità della community. Accedi ai loro forum di discussione, controlla gli account dei social media dei collaboratori (se parlano del loro progetto) ed esamina la loro documentazione di onboarding, se presente.
      • Se c'è un progetto con cui vorresti lavorare che non è presente nell'elenco dei progetti, contattalo e chiedi di prendere in considerazione la possibilità di presentare domanda.
  • Esamina le pagine delle proposte dei progetti.
    • Quando hai 3-5 progetti possibili, consulta la pagina della proposta di ciascun progetto
    • Dovresti porre domande, fornire feedback e fornire suggerimenti utilizzando i canali elencati dal progetto per feedback e discussioni.
  • Invia una dichiarazione di interesse direttamente all'organizzazione. Nella tua dichiarazione di interesse, mostrerai come raggiungeresti gli obiettivi indicati nella proposta di progetto dell'organizzazione.
    • Utilizza il modello di dichiarazione di interesse relativo alla stagione dei documenti. 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 eventuali requisiti speciali, assicurati di dimostrare di soddisfarli nell'estratto conto.
    • Inviando la tua dichiarazione di interesse, accetti di rispettare il codice di condotta dell'organizzazione e il codice di condotta della stagione dei documenti.

Fase di richiesta

  • Attendi l'annuncio delle organizzazioni accettate in base alla stagione dei documenti:
    • Le organizzazioni accettate ti contatteranno direttamente se vogliono 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 presentato dichiarazioni di interesse entro la scadenza della candidatura per l'organizzazione. Potranno richiedere ulteriori dichiarazioni di interesse dopo l'accettazione. Le organizzazioni devono selezionare un Technical Writer prima del 16 maggio 2022 alle 18:00 UTC.
    • Le organizzazioni non sono tenute a fornire feedback su dichiarazioni di interesse non andate a buon fine.

Fase di sviluppo del progetto

  • Collabora con l'organizzazione per creare un programma che includa 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.