Fase attuale:
Il programma per la stagione di Documenti 2021 è terminato il 14 dicembre 2021. Consulta la cronologia.
Questa pagina contiene suggerimenti per le organizzazioni open source su come valutare e selezionare il Technical writer giusto per la proposta di progetto per la stagione dei documenti.
Introduzione
Le organizzazioni open source devono assumere un Technical Writer per lavorare al progetto proposto. Le organizzazioni devono reperire il proprio Technical Writer. I Technical writer interessati a lavorare con le organizzazioni che partecipano al programma Season of Docs possono essere consultati nel repository GitHub di Season of Docs e nel canale#season-of-docs in Write the Docs Slack.
Valutazione di un Technical Writer
Ti consigliamo di richiedere esempi di documentazione sviluppata in precedenza dai Technical Writer che stai prendendo in considerazione, in modo da poterti concentrare sulla valutazione delle loro competenze e della loro esperienza in scrittura tecnica.
Competenze ed esperienza di scrittura tecnica
Esaminare le esperienze pregresse del Technical writer. Idealmente, il Technical writer deve avere una certa esperienza nella scrittura di documentazione tecnica per l'industria del software. Uno degli obiettivi di Season of Docs è offrire ai tecnici l'opportunità di interagire con prodotti incentrati sugli sviluppatori. Per questo motivo, non è essenziale che l'autore abbia esperienza con le API o gli SDK o altre piattaforme per sviluppatori, anche se il tuo progetto è incentrato su un pubblico di sviluppatori.
Concentrati sulle competenze linguistiche e comunicative. Valutare il lavoro precedente del Technical Writer da questo punto di vista. Ma soprattutto: riesci a capire cosa ha scritto la persona? Se vuoi svolgere una revisione approfondita del linguaggio del lavoro del redattore tecnico, cerca coerenza nella punteggiatura e nelle frasi, che non ci siano errori di ortografia e un linguaggio chiaro. La frase è semplice o complicata? Le frasi sono brevi o compaiono fino a quando non diventano difficili da seguire?
Presta attenzione alla progettazione e al layout dei documenti. Controlla il layout generale degli esempi di documenti. Il design è logico? Riesci a orientarti facilmente all'interno del set di documenti o di documentazione? I contenuti sono duplicati o lacune evidenti?