Fase attuale:
Risultati annunciati
tempistiche.
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.
Inizio del processo
Ti consigliamo di iniziare la procedura di ricerca di un Technical Writer non appena ritieni che potresti voler partecipare alla stagione di Documenti.
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?
Assunzione di un Technical Writer
Le organizzazioni devono assumere un Technical Writer e compilare il modulo per la prova di assunzione degli autori tecnici, accessibile tramite il link di seguito, entro il 16 maggio 2022 alle 18:00 UTC.
Fase di assunzione del Technical Writer completata.
Assicurati di discutere della retribuzione e del calendario dei pagamenti con il tecnico prima di procedere con l'assunzione. Consigliamo alle organizzazioni di creare un piano di pagamento con i Technical Writer in base agli obiettivi del progetto, incluso il pagamento all'avvio del progetto. Tieni presente le date di pagamento, che avverrà solo due volte durante il programma, e gli importi durante la creazione del calendario dei pagamenti.
Nota: le organizzazioni che non hanno assunto un responsabile della tecnologia e non hanno inviato il modulo di assunzione del Proof of Technical Writer Assunzione entro il 16 maggio 2022 alle 18:00 UTC non riceveranno fondi alla prima data di pagamento.