Fase attuale:
Il programma per la stagione dei documenti 2020 è terminato il 15 marzo 2021. Consulta la cronologia.
Questa pagina contiene linee guida per le organizzazioni open source su come valutare le proposte di progetto di scrittura tecnica e selezionare i progetti di cui vogliono fare da mentore nella stagione di Documenti.
Introduzione
I Technical Writer inviano le loro proposte per la stagione dei documenti per lavorare a un progetto con l'organizzazione open source selezionata. Gli amministratori dei programmi Google inoltrano le proposte alle organizzazioni open source per la valutazione e la selezione dei progetti. Per informazioni dettagliate sui passaggi da seguire, consulta la guida per l'amministratore dell'organizzazione.
Valutazione delle proposte di Technical Writer
Competenze ed esperienza di scrittura tecnica
Esaminare le esperienze pregresse del Technical writer. La proposta del Technical Writer include informazioni sulla sua più recente esperienza di scrittura tecnica. Idealmente, il richiedente deve avere una certa esperienza nella scrittura di documentazione tecnica per il settore del software. Uno degli obiettivi di Season of Docs è offrire ai tecnici l'opportunità di partecipare a prodotti incentrati sugli sviluppatori. Per questo motivo, non è essenziale che l'autore abbia esperienza con le API, 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 la proposta del Technical Writer da questo punto di vista. Ma soprattutto: riesci a capire cosa ha scritto la persona? In qualità di mentore, il tuo ruolo sarà aiutare il Technical Writer con i processi, gli strumenti e il codice open source, senza dover esaminare anche il testo della documentazione risultante. Se vuoi fare un esame approfondito della lingua della proposta, cerca la coerenza nella punteggiatura e alle frasi, l'ortografia corretta e il linguaggio chiaro. La frase è semplice o complicata? Le frasi sono brevi o continuano fino a diventare difficili da seguire?
Presta attenzione alla progettazione e al layout dei documenti. Come parte della sua proposta, il Technical Writer ha l'opportunità di fornire esempi della documentazione che ha sviluppato. Verifica il layout complessivo degli esempi di documenti. Il design è logico? Riesci a orientarti facilmente nel set di documenti o documenti? Esistono duplicati di contenuti o lacune evidenti?
La proposta
Verifica che la proposta soddisfi i tuoi requisiti. La proposta è legata a qualche idea di progetto che hai inviato per la stagione dei documenti di quest'anno? Se il Technical Writer ha proposto una nuova idea, verifica che la proposta soddisfi le esigenze del tuo progetto open source e che ci siano le persone giuste per aiutare il Technical Writer a raggiungere gli obiettivi del progetto proposto.
Cerca entusiasmo e completezza. La proposta dimostra che il Technical Writer è entusiasta del progetto? Valuta se il team ha riflettuto e lavorato nella proposta, consultando la tua organizzazione durante la fase di esplorazione o aggiungendo le loro opinioni su come raggiungere gli obiettivi del progetto.
Domande frequenti
Come decidiamo quanti progetti inviare?
Concentrati su uno o due progetti. Se la tua organizzazione ha la capacità di menzionare più di questo, puoi inviarne altre. Per ogni progetto di Technical Writer, è necessario almeno un mentore (preferibilmente due) che si impegni a fare il mentore solo del progetto.
Leggi le informazioni su come funziona l'allocazione degli slot per la stagione dei documenti.
Come scegliamo la proposta di scrittura tecnica da accettare?
Assicurati di selezionare la migliore delle proposte di Technical Writer che hai ricevuto. In altre parole, seleziona le proposte più adatte alle tue esigenze e che meglio si adattano alle linee guida per la valutazione elencate sopra.
Dove sono i moduli necessari per inviare le proposte selezionate?
Consulta la guida dell'amministratore dell'organizzazione.