Fase attuale:
il programma della Stagione dei documenti 2021 è terminato il 14 dicembre 2021. Consulta la cronologia.
Questa pagina è dedicata alle organizzazioni open source nella fase di esplorazione della procedura di richiesta di adesione. Queste idee di progetto sono solo esempi per mostrare come le organizzazioni potrebbero descrivere possibili progetti di documentazione nella pagina delle idee di progetto dell'organizzazione. Le organizzazioni possono proporre progetti non inclusi in questo elenco.
Idea di progetto: creare una guida alle operazioni preliminari per i collaboratori
Problema
- I nuovi collaboratori non riescono a trovare le informazioni di configurazione necessarie per dare un contributo significativo al nostro progetto. Alcune procedure (ad esempio la collaborazione ai nostri test) non sono affatto documentate.
Come misureremo il successo?
- Aumento del numero di nuovi collaboratori
- Aumento del numero di nuovi collaboratori non legati al codice (semplificando la collaborazione a documenti o test)
- Riduzione del numero di problemi segnalati dai nuovi collaboratori
- Aumento del numero di problemi chiusi con il tag "buon primo problema"
Quali competenze deve avere un autore di manuali tecnici per lavorare a questo progetto?
- Requisiti obbligatori:familiarità con GitHub (o disponibilità a lavorare tramite i tutorial di GitHub)
- Facoltativo: familiarità con il nostro test runner per eseguire i test e aggiornare la documentazione al riguardo
Volontari
Incoraggia i membri della community a registrarsi per ricevere assistenza con attività specifiche, ad esempio:
- @JaneQDev, posso aiutarti a rispondere alle domande sui nostri test
- @ChenPCoder, sarò felice di esaminare le richieste pull dei documenti
- @ErichJEngineer, puoi illustrare la procedura di contributo attuale con il Technical Writer
Dati di contatto
- I redattori tecnici interessati a lavorare a questo progetto devono inviare un'email a email@project. Includi i link ai tuoi lavori di scrittura tecnica o al tuo portfolio/résumé/CV.
Idea del progetto: scrivere tutorial per utilizzare la nostra libreria con ...
Problema
- Il nostro progetto riceve molti problemi segnalati dagli utenti che tentano di utilizzare la nostra libreria con $TechnologyX. Non abbiamo una guida chiara per l'integrazione con $TechnologyX e può essere complicato.
Come misureremo il successo?
- Diminuzione del numero di problemi taggati "$TechnologyX"
- Aumento del numero di richieste pull da parte di nuovi collaboratori che ci aiutano a correggere i bug o ad aggiungere informazioni alla documentazione relativa a $TechnologyX
- Altri link al nostro progetto dai progetti $TechnologyX
Quali competenze deve avere un autore di manuali tecnici per lavorare a questo progetto?
- Facoltativo: una certa familiarità con $TechnologyX
Volontari
Incoraggia i membri della community a registrarsi per aiutarti con attività specifiche, ad esempio:
- @JaneQDev, posso aiutarti a rispondere a domande su $TechnologyX
- @ChenPCoder, sarò felice di esaminare le richieste pull dei documenti
Dati di contatto
- I redattori tecnici interessati a lavorare a questo progetto devono inviare un'email a email@project. Includi link al tuo lavoro di scrittura tecnica o al tuo portfolio/curriculum/CV.
Idea del progetto: riorganizza la nostra documentazione
Problema
- La nostra documentazione è molto ampia e disorganizzata. Molti utenti rinunciano a cercare le risposte nella documentazione e si limitano a segnalare problemi o a porre domande nei nostri forum. Le nostre pagine non vengono visualizzate nei risultati di ricerca anche per le parole chiave pertinenti.
Come misureremo il successo?
- SEO migliorata per la nostra documentazione
- Riduzione del numero di problemi segnalati per gli argomenti trattati nella documentazione
- Aumento del numero di contributi alla documentazione
Quali competenze deve avere un autore di manuali tecnici per lavorare a questo progetto?
- Facoltativo: esperienza nella riorganizzazione di set di documentazione di grandi dimensioni e consolidati, conoscenza della SEO
Volontari
Incoraggia i membri della community a registrarsi per aiutarti con attività specifiche, ad esempio:
- @ChenPCoder, sono felice di esaminare le richieste di pull dei documenti
Dati di contatto
- I redattori tecnici interessati a lavorare a questo progetto devono inviare un'email a email@project. Includi i link ai tuoi lavori di redazione tecnica o al portfolio/curriculum/CV.
Idea del progetto: esegui un problema relativo alla documentazione
Problema
- Abbiamo molti piccoli bug e problemi vecchi relativi alla nostra documentazione. La nostra community sarebbe felice di presentarti e aiutarti a sistemare le cose, ma abbiamo bisogno di qualcuno che si occupi di organizzare ed eseguire la correzione.
Come possiamo misurare il successo?
- Numero di problemi relativi alla documentazione chiusi
- Aumento del numero di contributi alla documentazione e di nuovi collaboratori
Quali competenze deve avere un autore di manuali tecnici per lavorare a questo progetto?
- Facoltativo: esperienza nell'esecuzione di una correzione della documentazione
- Ottime capacità organizzative
Volontari
Incoraggia i membri della community a registrarsi per ricevere assistenza con attività specifiche, ad esempio:
- @ChenPCoder, puoi aiutarci a organizzare il video e la chat per la risoluzione dei problemi e aiutarci a trovare volontari in altri fusi orari
Dati di contatto
- I redattori tecnici interessati a lavorare a questo progetto devono inviare un'email a email@project/aprire un problema/chiedere nel nostro forum. Includi link ai tuoi lavori di scrittura tecnica o al tuo portfolio/curriculum/CV.
Idea del progetto: esegui un controllo della documentazione
Problema
- Non abbiamo una buona idea dello stato della nostra documentazione. È difficile dare la priorità ai miglioramenti della documentazione perché non abbiamo una roadmap o un'idea di quali siano i problemi più urgenti. Abbiamo anche molti contenuti obsoleti che devono essere eliminati o archiviati.
Come misureremo il successo?
- Creazione di una roadmap della documentazione con l'approvazione generale della community
- Diminuzione del numero di pagine di documentazione obsolete o errate
Quali competenze deve avere un autore di manuali tecnici per lavorare a questo progetto?
- Vantaggio: esperienza con i controlli dei documenti
Volontari
Incoraggia i membri della community a registrarsi per ricevere assistenza con attività specifiche, ad esempio:
- @JaneQCoder, puoi aiutarci a coordinare la presentazione della roadmap della documentazione nella nostra riunione della community
Dati di contatto
- I redattori tecnici interessati a lavorare a questo progetto devono inviare un'email a email@project/aprire un problema/chiedere nel nostro forum. Includi link ai tuoi lavori di scrittura tecnica o al tuo portfolio/curriculum/CV.
Informazioni correlate
- La pagina Promozione e stampa include loghi e altri contenuti che puoi utilizzare quando parli della Stagione dei documenti di Google.
- Questo video della PyCon Australia 2017 fornisce suggerimenti su come organizzare la documentazione in modo che sia utile per gli utenti: Cosa non ti dice nessuno sulla documentazione di Daniele Procida.