Ti diamo il benvenuto nella stagione di Documenti.
Promuovere la collaborazione open source con i Technical Writer
Fase attuale:
Il programma per la stagione dei documenti 2019 è terminata il 6 marzo 2020. Consulta la cronologia.
L'obiettivo di Season of Docs è fornire un framework a cui i Technical Writer e i progetti open source possano collaborare per raggiungere l'obiettivo comune di migliorare la documentazione di un progetto open source. Per i Technical Writer che non conoscono l'open source, il programma offre l'opportunità di acquisire esperienza nell'ambito dei contributi a progetti open source. Per i tecnici che stanno già lavorando all'open source, il programma offre un modo potenzialmente nuovo di collaborare. Season of Docs offre anche ai progetti open source l'opportunità di coinvolgere più membri della community di Technical Writer.
Durante il programma, i Technical Writer trascorrono alcuni mesi a lavorare a stretto contatto con una community open source. Portano le loro competenze di scrittura tecnica nella documentazione del progetto e allo stesso tempo imparano a conoscere il progetto open source e le nuove tecnologie.
I progetti open source collaborano con i Technical Writer per migliorare la documentazione e i processi del progetto. Insieme possono scegliere di creare un nuovo set di documentazione o riprogettare i documenti esistenti oppure di migliorare e documentare le procedure di contributo e l'esperienza di onboarding della community open source.
Insieme, aumentiamo la consapevolezza pubblica riguardo ai documenti open source, alla scrittura tecnica e a come possiamo collaborare a vantaggio della community open source globale.
Come funziona?
Ecco il flusso di lavoro generale del programma Season of Docs:
Quest'anno, le organizzazioni open source possono diventare mentori per la stagione dei documenti. Possono inviare un elenco di idee per un progetto di documentazione insieme alle domande di partecipazione.
I Technical writer esaminano l'elenco delle organizzazioni partecipanti e scelgono i progetti che li interessano. Un tecnico può contattare le organizzazioni preposte per discutere delle proprie idee. Il Technical writer quindi scrive una proposta di progetto e la invia a Season of Docs.
Le organizzazioni confermano i progetti di scrittura tecnica di cui vogliono eseguire il mentore.
I Technical Writer accettati passano alcuni mesi a lavorare con i mentori delle organizzazioni open source per completare i loro progetti.
Alla fine del programma, gli amministratori del programma Google annunciano i progetti completati correttamente.
La sequenza temporale mostra i dettagli dei passaggi previsti e le date principali.
Partecipanti e ruoli
Di seguito sono riportati i principali gruppi di persone che partecipano alla Stagione di Documenti e il ruolo svolto da ogni gruppo nel programma:
Gli amministratori dell'organizzazione sono membri delle organizzazioni open source partecipanti che agiscono come contatto principale per la stagione dei documenti per la loro organizzazione. Gli amministratori dell'organizzazione inviano la richiesta dell'organizzazione per partecipare alla stagione dei documenti, gestire i mentori all'interno delle loro organizzazioni, assicurarsi che i progetti di scrittura tecnica restino in linea, gestire i documenti cartacei e la distribuzione dello stipendio del mentore. Consulta la guida e le responsabilità per gli amministratori
I mentori open source sono membri delle organizzazioni open source partecipanti che vengono accettate come mentori per la stagione dei documenti di quest'anno. I mentori lavorano a stretto contatto con i Technical Writer per garantire il successo del progetto. Consulta la guida e le responsabilità del mentore.
I Technical writer sono esperti di tech writer di tutto il mondo che vengono accettati per partecipare alla stagione dei documenti di quest'anno. I candidati devono essere in grado di dimostrare la precedente esperienza di scrittura tecnica inviando descrizioni dei ruoli ed esempi di lavoro. Consulta la guida e le responsabilità per il Technical Writer.
Gli amministratori dei programmi Google sono program manager all'interno di Google che eseguono il programma Stagione dei documenti.
Passaggi successivi
- Iscriviti alla mailing list per l'annuncio del season-of-docs-announce per essere sempre al corrente dell'apertura delle candidature e di altri importanti eventi del programma.
- Controlla la sequenza temporale per verificare le date e i traguardi importanti.
- Inizia registrandoti come partecipanti, indipendentemente dal fatto che tu sia un Technical Writer o un membro di un progetto open source.
- In caso di dubbi, leggi le Domande frequenti.
- Contattaci se hai bisogno di ulteriore assistenza o vuoi partecipare alle discussioni.