Fase attuale:
Case study pubblicati. 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. I redattori tecnici interessati a collaborare con le organizzazioni che partecipano a Google Season of Docs possono trovarli nel repo GitHub di Google Season of Docs e nel canale#season-of-docs nel canale Slack di Write the Docs.
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 ai redattori tecnici che stai valutando degli esempi di documentazione sviluppata in precedenza, in modo da poter valutare le loro competenze e la loro esperienza nella scrittura tecnica.
Competenze ed esperienza nella scrittura tecnica
Esamina l'esperienza pregressa del redattore tecnico. Idealmente, il redattore tecnico dovrebbe avere una certa esperienza nella scrittura di documentazione tecnica per il settore 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 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 proseguono fino a diventare 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 22 maggio 2024.
Fase di assunzione di autori tecnici completata.
Prima di assumere il Technical Writer, assicurati di discutere di compenso e di una paga. Consigliamo alle organizzazioni di creare un programma dei pagamenti con i redattori tecnici in base ai traguardi del progetto, incluso un pagamento all'avvio 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 un technical writer e non hanno inviato il Modulo di conferma dell'assunzione di un technical writer entro le ore 18:00 UTC del 22 maggio 2024 non riceveranno fondi alla prima data di pagamento.