Fase attuale:
Sviluppo della documentazione. 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 Stagione di Documenti Google.
Introduzione
Le organizzazioni open source devono assumere un Technical Writer per lavorare al progetto proposto. Le organizzazioni devono disporre del proprio Technical Writer. I Technical writer interessati a collaborare con le organizzazioni che partecipano alla stagione di Documenti Google possono essere disponibili nel repository GitHub della stagione dei documenti Google e nel canale#season-of-docs in Write the Docs Slack.
Inizio del processo
Ti consigliamo di iniziare il processo di ricerca di un Technical Writer il prima possibile, man mano che pensi di poter partecipare alla stagione di Documenti Google.
Valutazione di un Technical writer
Ti consigliamo di richiedere esempi di documentazione precedentemente sviluppata agli autori tecnici che stai prendendo in considerazione, in modo da poter valutare le loro competenze ed esperienze di 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 redazione di documentazione tecnica per il settore del software. Uno degli obiettivi di Google Season of Docs è offrire ai Technical Writer l'opportunità di interagire con i 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. Valuta il lavoro precedente dell'autore tecnico da questo punto di vista. Ma soprattutto: riesci a capire cosa ha scritto la persona? Se vuoi svolgere un'analisi approfondita del linguaggio del lavoro del redattore tecnico, cerca la coerenza nella punteggiatura e la frase, l'ortografia e il linguaggio chiaro. La frase è semplice o complicata? Le frasi sono brevi o continuano finché non diventano difficili da seguire?
Presta attenzione alla progettazione e al layout dei documenti. Controlla il layout complessivo degli esempi di documenti. La progettazione è logica? Riesci a orientarti facilmente all'interno del set di documenti o di documentazione? Ci sono duplicati di contenuti o lacune evidenti?
Assumere un Technical Writer
Le organizzazioni devono assumere un Technical Writer e compilare il modulo per la prova di assunzione di un Technical Writer, accessibile tramite il link riportato di seguito, entro il 22 maggio 2024 alle 18:00 UTC.
Fase di assunzione del Technical Writer completata.
Prima di richiedere l'assunzione, assicurati di discutere della retribuzione e del calendario dei pagamenti con il tecnico tecnico. Consigliamo alle organizzazioni di creare un calendario dei pagamenti con Technical Writer in base agli obiettivi del progetto, incluso un pagamento all'avvio del progetto. Tieni presente le date di pagamento, che avvengono solo due volte durante il programma, e gli importi quando crei un calendario dei pagamenti.
Nota: le organizzazioni che non hanno assunto un redattore tecnico e non hanno inviato il modulo di Proof of Technical Writer Assunzione entro il 22 maggio 2024 alle 18:00 UTC non riceveranno fondi alla prima data di pagamento.