Fase attuale:
Sviluppo della documentazione. Consulta la cronologia.
Di seguito sono riportate alcune linee guida per aiutare le organizzazioni open source a lavorare in modo efficace con gli scrittori tecnici.
Presenta al Technical Writer il mondo dell'open source e alla tua community
- Offri al tecnico un "tour guidato" della tua community. A chi possono porre domande? A quali riunioni periodiche dovrebbe partecipare o a quali mailing list deve partecipare? Di quali account hanno bisogno (Github, Discord, Slack)? Assicurati che 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 soddisfi tutti i requisiti degli altri datori di lavoro in merito alla firma di CLA, DCO o altri contratti.
- Se possibile, presenta loro alcune persone in fusi orari sovrapposti in grado di rispondere rapidamente alle domande sulla community o sul progetto.
- Se puoi, invia loro dei gadget per i progetti.
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 guidare il Technical writer nella sua prima procedura di contributo, problema o richiesta di pull. Quali modelli o tag dovrebbe utilizzare? Chi deve rivedere il suo contributo e come e quando dovrebbe farlo? Se il loro lavoro include esempi di codice, come possono essere testati? Cosa devono sapere sul processo o sulle release CI/CD?
Aiutare il Technical Writer a comprendere il tuo progetto e i suoi utenti
- Spiega il tuo progetto in modo dettagliato in modo che il tecnico possa acquisire una comprensione concettuale del prodotto. In questo modo, il tecnico può sentirsi più sicuro e autorevole nello scrivere il progetto.
- Descrivi le esigenze delle persone che utilizzano il progetto. Sii il più specifico possibile: non soltanto "sviluppatori", ma "sviluppatori che creano siti web" e "sviluppatori che programmano robot industriali".
- Metti il tecnico in contatto con gli esperti necessari della materia. ovvero gli sviluppatori o gli altri collaboratori del progetto responsabili degli aspetti del progetto di cui tratterà la documentazione.
- Assicurati che il Technical Writer riceva il tempo e le risorse di cui ha bisogno dagli esperti della materia e da qualsiasi altro membro della community.
Fai domande.
- La tua community o il tuo progetto potrebbero non aver mai collaborato con i Technical Writer o con i collaboratori alla documentazione. Sfrutta l'opportunità di imparare condividendo le tue conoscenze. Chiedi un feedback sui tuoi processi e strumenti: il tuo Technical writer probabilmente avrà qualche suggerimento per migliorarlo.