Fase attuale:
il programma della Stagione dei documenti 2021 è terminato il 14 dicembre 2021. Visualizza
sequenza temporale.
Questa pagina contiene suggerimenti per le organizzazioni open source su come valutare e selezionare l'autore tecnico giusto per la proposta di progetto di Google Season di Documenti.
Introduzione
Le organizzazioni open source devono assumere un autore tecnico per lavorare al progetto proposto. Le organizzazioni devono trovare il proprio autore tecnico. I redattori tecnici interessati a collaborare con le organizzazioni che partecipano a Google Season of Docs possono essere trovati nel repository GitHub di Google Season of Docs e nel canale#season-of-docs di Write the Docs Slack.
Valutazione di un Technical Writer
Ti consigliamo di richiedere esempi di documentazione sviluppata in precedenza ai redattori tecnici che stai valutando, in modo da poter concentrarti sulla valutazione delle loro competenze ed esperienza nella scrittura tecnica.
Competenze ed esperienza di scrittura tecnica
Esamina l'esperienza pregressa del redattore tecnico. Idealmente, l'autore tecnico dovrebbe avere esperienza nella scrittura di documenti tecnici per l'industria del software. Uno degli obiettivi della stagione di Documenti Google è dare agli scrittori tecnici l'opportunità di interagire con prodotti incentrati sugli sviluppatori. Per questo motivo, non è essenziale che il autore abbia esperienza con API, SDK o altre piattaforme per sviluppatori, anche se il tuo progetto si rivolge a un pubblico di sviluppatori.
Concentrati sulle competenze linguistiche e di comunicazione. Valuta il lavoro precedente del tecnico della documentazione da questo punto di vista. Ma soprattutto: riesci a capire cosa ha scritto la persona? Se vuoi eseguire un esame approfondito del linguaggio del lavoro del redattore tecnico, cerca coerenza nella punteggiatura e nella formulazione, ortografia corretta e linguaggio chiaro. La formulazione è semplice o complicata? Le frasi sono brevi o continuano fino a essere difficili da seguire?
Presta attenzione al design e al layout del documento. Controlla il layout generale dei documenti di esempio. Il design è logico? Puoi muoverti facilmente all'interno del documento o del set di documentazione? Esistono contenuti duplicati o sono presenti lacune evidenti?