Fase attuale:
Risultati annunciati. Consulta la cronologia.
Questa pagina è rivolta alle organizzazioni open source nella fase di esplorazione del processo di candidatura dell'organizzazione. Queste idee per i progetti sono solo esempi per mostrare come le organizzazioni potrebbero descrivere possibili progetti di documentazione nella pagina delle idee per i progetti dell'organizzazione; le organizzazioni possono proporre progetti non inclusi in questo elenco.
Idea di progetto: guida alle operazioni preliminari per la creazione di un collaboratore
Problema
- I nuovi collaboratori non riescono a trovare le informazioni di configurazione necessarie per dare contributi significativi al nostro progetto. Alcuni processi (ad esempio il contributo ai nostri test) non sono documentati.
Come misureremmo il successo?
- Aumento del numero di nuovi collaboratori
- Aumento del numero di nuovi collaboratori non di codice (semplificando il contributo alla documentazione o ai test)
- Diminuzione del numero di problemi segnalati dai nuovi collaboratori
- Aumento del numero di problemi chiusi contrassegnati con "primo problema valido"
Di quali competenze ha bisogno un Technical Writer per lavorare su questo progetto?
- Devi avere:familiarità con GitHub (o disponibilità a lavorare tramite tutorial di GitHub)
- Vantaggio: familiarità con il nostro esecutore del test, per eseguire i nostri test e aggiornare la documentazione in merito.
Volontari
Incoraggia i membri della community a registrarsi per ricevere aiuto per attività specifiche, ad esempio:
- @JaneQDev, può rispondere alle domande sui nostri test
- @ChenPCoder, siamo felici di esaminare le richieste di pull dei documenti
- @ErichJEngineer, può seguire l'attuale procedura di aggiunta dei contributi con Technical Writer
Dati di contatto
- I Technical writer interessati a questo progetto devono inviare un'email all'indirizzo email@project. Includi i link al tuo lavoro di redazione tecnica o al portfolio/résumé/CV.
Idea di progetto: scrivi tutorial per utilizzare la nostra libreria con ...
Problema
- Il nostro progetto riceve molti problemi sollevati dagli utenti che cercano di utilizzare la nostra raccolta con $TechnologyX. Non abbiamo una guida chiara per l'integrazione con $TechnologyX e può essere difficile.
Come misureremmo il successo?
- Diminuzione del numero di problemi etichettati come "$TechnologyX"
- Aumento del numero di richieste di pull da parte di nuovi collaboratori che ci aiutano a correggere bug o aggiungere alla documentazione su $TechnologyX
- Altri link al nostro progetto dai progetti $TechnologyX
Di quali competenze ha bisogno un Technical Writer per lavorare su questo progetto?
- Ideale: un po' di familiarità con $TechnologyX
Volontari
Incoraggia i membri della community a registrarsi per ricevere aiuto per attività specifiche, ad esempio:
- @JaneQDev, può rispondere alle domande su $TechnologyX
- @ChenPCoder, siamo felici di esaminare le richieste di pull dei documenti
Dati di contatto
- I Technical writer interessati a questo progetto devono inviare un'email all'indirizzo email@project. Includi i link al tuo lavoro di redazione tecnica o a portfolio/résumé/CV.
Idea sul progetto: riorganizzare la documentazione
Problema
- La nostra documentazione è estesa e disorganizzata. Molti utenti rinunciano a trovare le risposte nella documentazione e si limitano a sollevare problemi o porre domande nei nostri forum. Le nostre pagine non compaiono nei risultati di ricerca nemmeno per parole chiave pertinenti.
Come misureremmo il successo?
- SEO migliore per la nostra documentazione
- Diminuzione del numero di problemi segnalati per gli argomenti trattati nella documentazione
- Aumento del numero di contributi alla documentazione
Di quali competenze ha bisogno un Technical Writer per lavorare su questo progetto?
- Piacere di avere: esperienza con la riorganizzazione di grandi e maturi set di documenti, comprensione della SEO
Volontari
Incoraggia i membri della community a registrarsi per ricevere aiuto per attività specifiche, ad esempio:
- @ChenPCoder, siamo felici di esaminare le richieste di pull dei documenti
Dati di contatto
- I Technical writer interessati a questo progetto devono inviare un'email all'indirizzo email@project. Includi i link al tuo lavoro di redazione tecnica o a portfolio/résumé/CV.
Idea di progetto: esecuzione di una correzione della documentazione
Problema
- Abbiamo molti piccoli bug e vecchi problemi relativi alla nostra documentazione. La nostra community sarà lieta di intervenire e ti aiuterà a ripulire, ma abbiamo bisogno di qualcuno che organizzi ed esegua il fixit.
Come misureremmo il successo?
- Numero di problemi relativi alla documentazione chiusi
- Aumento del numero di contributi alla documentazione e nuovi collaboratori
Di quali competenze ha bisogno un Technical Writer per lavorare su questo progetto?
- Vantaggio: esperienza con l'esecuzione di una correzione della documentazione
- Ottime capacità organizzative
Volontari
Incoraggia i membri della community a registrarsi per ricevere aiuto per attività specifiche, ad esempio:
- @ChenPCoder, può aiutarti a organizzare il video e la chat per risolvere il problema e a trovare volontari in altri fusi orari
Dati di contatto
- I Technical writer interessati a questo progetto devono inviare un'email all'indirizzo email@project/open a issue/ask nel nostro forum. Includi i link al tuo lavoro di redazione tecnica o a portfolio/résumé/CV.
Idea di 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 senso dei problemi più urgenti. Abbiamo anche molti contenuti obsoleti che dovrebbero essere eliminati o archiviati.
Come misureremmo il successo?
- Creazione di una roadmap della documentazione con l'approvazione generale della community
- Riduzione del numero di pagine di documentazione obsolete o errate
Di quali competenze ha bisogno un Technical Writer per lavorare su questo progetto?
- Vantaggio: esperienza nel controllo di documenti
Volontari
Incoraggia i membri della community a registrarsi per ricevere aiuto per attività specifiche, ad esempio:
- @JaneQCoder, può aiutarti a coordinare la presentazione della roadmap della documentazione durante la riunione della community
Dati di contatto
- I Technical writer interessati a questo progetto devono inviare un'email all'indirizzo email@project/open a issue/ask nel nostro forum. Includi i link al tuo lavoro di redazione tecnica o a portfolio/résumé/CV.
Informazioni correlate
- La pagina relativa a promozione e stampa include loghi e altri contenuti che puoi utilizzare quando parli della stagione dei documenti Google.
- Questo video di PyCon Australia 2017 offre suggerimenti su come organizzare la documentazione in modo che le persone la trovino utile: Cosa dice nessuno sulla documentazione di Daniele Procida.