Fase attuale:
Risultati annunciati
tempistiche.
Di seguito sono riportate alcune linee guida per aiutare le organizzazioni open source a collaborare in modo efficace con i Technical Writer.
Presenta al Technical Writer il mondo dell'open source e la tua community
- Offri al tecnico un "tour guidato" della tua community. Dove possono porre domande? A quali riunioni periodiche dovrebbe partecipare o a quali mailing list dovrebbe partecipare? Di quali account hanno bisogno (Github, Discord, Slack)? Assicurati che gli studenti comprendano il codice di condotta del tuo progetto e sappiano come segnalare eventuali problemi. Assicurati che il tuo Technical Writer comprenda la licenza del tuo progetto e che rispetti tutti i requisiti di altri datori di lavoro in merito alla firma di CLA, DCO o altri contratti.
- Se possibile, presenta loro alcune persone in fusi orari sovrapposti che possono rispondere rapidamente alle domande sulla comunità o sul progetto.
- Se puoi, invia loro dei gadget per il tuo progetto.
Aiuta il Technical Writer a utilizzare gli strumenti e i processi coinvolti nel contributo al tuo progetto
- Se i tuoi processi non sono ben documentati, fissa un orario per illustrare al Technical Writer il suo primo contributo, problema o richiesta di pull. Quali modelli o tag dovrebbe utilizzare? Chi deve rivedere il proprio contributo e come e quando dovrebbe dare seguito alle recensioni? Se il loro lavoro include esempi di codice, come possono essere testati? Cosa devono sapere sul tuo processo o sulle tue release CI/CD?
Aiuta il Technical Writer a comprendere il tuo progetto e i suoi utenti
- Spiega il tuo progetto nei dettagli, in modo che il Technical Writer possa acquisire una solida comprensione concettuale del prodotto. In questo modo, il Technical Writer può sentirsi più sicuro e più autorevole nella scrittura del progetto.
- Descrivi le esigenze delle persone che utilizzano il progetto. Sii il più specifico possibile: non soltanto "sviluppatori" ma anche "sviluppatori che creano siti web" e "sviluppatori che programmano robot industriali".
- Mettono il Technical Writer in contatto con gli esperti in materia. ovvero gli sviluppatori o altri collaboratori del progetto responsabili degli aspetti del progetto trattati nella documentazione.
- Assicurati che il Technical Writer riceva il tempo e le risorse di cui ha bisogno dagli esperti in materia e da qualsiasi altro membro della community.
Fai domande.
- È possibile che la tua community o il tuo progetto non abbiano mai collaborato con i Technical Writer o con i collaboratori alla documentazione. Sfrutta l'opportunità di imparare condividendo le tue conoscenze. Chiedi un feedback sulle tue procedure e sui tuoi strumenti: il tuo Technical Writer potrebbe avere dei suggerimenti da migliorare.