Collaborare con un Technical Writer

Fase attuale:
Il programma per la stagione dei documenti 2019 è terminata il 6 marzo 2020. Consulta la cronologia.

Ecco alcune linee guida per le organizzazioni open source su come collaborare con un Technical Writer a cui fai da mentore per la stagione di Documenti:

  • Introduci il Technical Writer al mondo dell'open source e alla tua community.
  • Aiuta il Technical Writer a utilizzare gli strumenti e i processi coinvolti nel tuo progetto.
  • Spiega il prodotto in modo dettagliato, in modo che il Technical Writer possa comprendere a fondo il prodotto. In questo modo, il Technical Writer può sentirsi più sicuro e più autorevole nella scrittura del progetto.
  • Descrivi le esigenze del tuo pubblico, ovvero quelle degli sviluppatori che utilizzano il tuo prodotto e/o di altri gruppi che utilizzano il prodotto.
  • Workshop sui casi d'uso importanti con il Technical Writer, per aiutarlo a progettare la documentazione richiesta.
  • Esamina il codice quando il Technical Writer deve comprenderlo prima di scrivere i documenti.
  • Mettono il Technical Writer in contatto con gli esperti in materia. ovvero gli sviluppatori o altri collaboratori del progetto responsabili degli aspetti del prodotto 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.
  • Collabora con il Technical Writer per aggiungere esempi di codice significativi ai documenti, se pertinenti.

Aspetti da tenere presenti

I mentori open source in Season of Docs non sono necessariamente Technical Writer. I mentori non hanno bisogno di competenze documentali. I Technical Writer portano queste competenze al progetto e al rapporto di mentoring.

Al contrario, i mentori apportano le proprie conoscenze della community open source, del prodotto, dei processi e degli strumenti utilizzati dal progetto open source.

Un risultato importante del rapporto di mentoring dovrebbe essere quello di avere un'esperienza gratificante e di successo nella stagione di Documenti di quest'anno. Un'esperienza felice aumenta le possibilità che il Technical Writer continui a contribuire al progetto open source dopo la chiusura della stagione di Documenti di quest'anno e che altri Technical Writer diventino entusiasti di lavorare in open source.