Fase attuale:
Risultati annunciati. Consulta la cronologia.
Di seguito sono riportate alcune linee guida per aiutare le organizzazioni open source a collaborare in modo efficace con i redattori tecnici.
Presenta il redattore tecnico al mondo dell'open source e alla tua community
- Offri al tecnico della scrittura un "tour guidato" della tua community. Dove possono porre domande? A quali riunioni regolari deve partecipare o a quali mailing list deve iscriversi? Quali account sono necessari (GitHub, Discord, Slack)? Assicurati che comprendano il codice di condotta del progetto e che sappiano come segnalare eventuali problemi. Assicurati che il tuo Technical Writer comprenda la licenza del tuo progetto e rispetti i requisiti di altri datori di lavoro in merito alla firma di CLA, DCO o altri contratti.
- Se possibile, presenta loro alcune persone che si trovano in fusi orari sovrapposti, in grado di rispondere rapidamente alle domande sulla community o sul progetto.
- Se puoi, inviagli dei gadget del progetto.
Aiuta l'autore tecnico a utilizzare gli strumenti e i processi necessari per contribuire al tuo progetto
- Se le tue procedure non sono ben documentate, fissa un appuntamento per illustrare al tecnico della documentazione il suo primo contributo, problema o richiesta di pull. Quali modelli o tag devono utilizzare? Chi deve esaminare il proprio contributo e come e quando deve seguire le revisioni? Se il loro lavoro include esempi di codice, come possono essere testati? Cosa devono sapere sulle release o sul processo CI/CD?
Aiuta il tecnico della scrittura a comprendere il progetto e i relativi utenti
- Spiega il progetto in dettaglio in modo che il tecnico della scrittura acquisisca una solida comprensione concettuale del prodotto. In questo modo, il tecnico della scrittura può sentirsi più sicuro e autorevole nella scrittura del progetto.
- Descrivi le esigenze delle persone che utilizzano il progetto. Cerca di essere il più specifico possibile, non solo "sviluppatori", ma "sviluppatori che creano siti web" e "sviluppatori che programmano robot industriali".
- Mettere il tecnico redattore in contatto con gli esperti in materia necessari. Ovvero gli sviluppatori o altri collaboratori del progetto responsabili degli aspetti del progetto che verranno trattati nella documentazione.
- Assicurati che il redattore tecnico riceva il tempo e le risorse di cui ha bisogno dagli esperti della materia e da altri membri della community.
Fai domande.
- La tua community o il tuo progetto potrebbero non aver mai collaborato con autori tecnici o collaboratori alla documentazione. Sfrutta l'opportunità di apprendere mentre condividi le tue conoscenze. Chiedi un feedback sulle tue procedure e sui tuoi strumenti: il tuo autore tecnico avrà probabilmente alcuni suggerimenti per il miglioramento.