Fase attuale:
Risultati annunciati. Consulta la cronologia.
Questa pagina contiene suggerimenti per le organizzazioni open source su come valutare e selezionare il Technical Writer giusto per la proposta del progetto Google Season of Docs.
Introduzione
Le organizzazioni open source devono assumere un redattore tecnico per lavorare al progetto proposto. Le organizzazioni devono trovare il proprio autore tecnico. Gli scrittori tecnici interessati a collaborare con le organizzazioni che partecipano alla stagione di Documenti Google possono essere trovati nel repository GitHub di Google Season di Documenti e nel canale#season-of-docs di Writer the Docs Slack.
Avvio della procedura
Ti consigliamo di iniziare la procedura di ricerca di un autore tecnico non appena pensi di voler partecipare alla Stagione dei documenti di Google.
Valutazione di uno scrittore tecnico
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 nella 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 della documentazione di Google è offrire ai Technical Writer l'opportunità di collaborare con i prodotti rivolti agli 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 quella 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 frase è 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?
Assunzione di uno scrittore tecnico
Le organizzazioni devono assumere un autore tecnico e compilare il Modulo di prova dell'assunzione di un autore tecnico collegato di seguito entro le ore 18:00 UTC del 10 maggio 2023.
Fase di assunzione di autori tecnici completata.
Prima di assumere un autore tecnico, assicurati di discutere di compenso e di una paga. Consigliamo alle organizzazioni di creare un calendario dei pagamenti con i Technical Writer in base alle tappe del progetto, incluso un pagamento al lancio del progetto. Tieni presente le date di pagamento, che si verificano solo due volte durante il programma, e gli importi quando crei una pianificazione dei pagamenti.
Nota: le organizzazioni che non hanno assunto uno scrittore tecnologico e hanno inviato il modulo Proof of Technical Writer Assunzione entro il 10 maggio 2023 alle 18:00 UTC non riceveranno i fondi alla prima data di pagamento.