Fase attuale:
Sviluppo della documentazione. Consulta la cronologia.
Questa pagina è dedicata alle organizzazioni open source nella fase di esplorazione del processo di applicazione dell'organizzazione. Queste idee per i progetti sono solo esempi per mostrare in che modo 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: creare una guida alle operazioni preliminari per i collaboratori
Problema
- I nuovi collaboratori non riescono a trovare le informazioni di configurazione necessarie per apportare contributi significativi al nostro progetto. Alcuni processi (come il contributo ai nostri test) non sono affatto documentati.
Come misuriamo il successo?
- Aumento del numero di nuovi collaboratori
- Aumento del numero di nuovi collaboratori non di codice (semplificando il contributo a documenti o 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?
- È necessario avere: familiarità con GitHub (o disponibilità a lavorare tramite tutorial GitHub)
- Vantaggio: familiarità con il nostro test runner, per eseguire i test e aggiornare la documentazione per farlo
Volontari
Incoraggia i membri della community a registrarsi per aiutarli a svolgere attività specifiche, ad esempio:
- @JaneQDev, può rispondere alle domande sui nostri test
- @ChenPCoder, siamo felici di esaminare le richieste pull dei documenti
- @ErichJEngineer, può seguire l'attuale processo di inserimento dei contributi con Technical Writer
Dati di contatto
- I Technical writer interessati a questo progetto devono inviare un'email all'indirizzo email@project. Includi link al tuo lavoro di redazione tecnica o al tuo portfolio/curriculum/CV.
Idea di progetto: scrivere tutorial per utilizzare la nostra libreria con ...
Problema
- Il nostro progetto riceve numerosi problemi sollevati dagli utenti che cercano di utilizzare la nostra libreria con $TechnologyX. Non abbiamo una guida chiara per l'integrazione con $TechnologyX e può essere difficile.
Come misuriamo il successo?
- Diminuzione del numero di problemi contrassegnati con "$TechnologyX"
- di aumento delle richieste di pull da parte di nuovi collaboratori, che ci aiuta a correggere i bug o ad aggiungere alla documentazione
- Altri link al nostro progetto dai progetti $TechnologyX
Di quali competenze ha bisogno un Technical Writer per lavorare su questo progetto?
- Utili da avere: un po' di familiarità con $TechnologyX
Volontari
Incoraggia i membri della community a registrarsi per aiutarli a svolgere attività specifiche, ad esempio:
- @JaneQDev, può rispondere alle domande su $TechnologyX
- @ChenPCoder, siamo felici di esaminare le richieste pull dei documenti
Dati di contatto
- I Technical writer interessati a questo progetto devono inviare un'email all'indirizzo email@project. Includi link al tuo lavoro di redazione tecnica o al tuo portfolio/curriculum/CV.
Idea di progetto: riorganizzare la nostra documentazione
Problema
- La nostra documentazione è ampia e disorganizzata. Molti utenti rinunciano a trovare risposte nella documentazione e si limitano a segnalare problemi o porre domande nei nostri forum. Le nostre pagine non compaiono nei risultati di ricerca neanche per parole chiave pertinenti.
Come misuriamo il successo?
- Migliorare la SEO per la nostra documentazione
- Diminuzione del numero di problemi sollevati 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?
- Buono a sapersi: esperienza con la riorganizzazione di vasti e sofisticati set di documenti, comprensione della SEO
Volontari
Incoraggia i membri della community a registrarsi per aiutarli a svolgere attività specifiche, ad esempio:
- @ChenPCoder, siamo felici di esaminare le richieste pull dei documenti
Dati di contatto
- I Technical writer interessati a questo progetto devono inviare un'email all'indirizzo email@project. Includi link al tuo lavoro di redazione tecnica o al tuo portfolio/curriculum/CV.
Idea di progetto: esegui una correzione della documentazione
Problema
- Abbiamo molti bug e vecchi problemi relativi alla nostra documentazione. La nostra community sarebbe felice di partecipare e aiutarti a ripulire, ma abbiamo bisogno di qualcuno che si occupi dell'organizzazione e della risoluzione del problema.
Come misuriamo 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?
- Ideale: esperienza con l'esecuzione di una correzione della documentazione
- Ottime capacità organizzative
Volontari
Incoraggia i membri della community a registrarsi per aiutarli a svolgere 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 in caso di problemi o porre domande nel nostro forum. Includi link al tuo lavoro di scrittura tecnica o al tuo portfolio/curriculum/CV.
Idea di progetto: eseguire un controllo della documentazione
Problema
- Non abbiamo una buona idea dello stato della nostra documentazione. È difficile dare 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 misuriamo il successo?
- Creazione di una roadmap di documentazione con l'approvazione generale della community
- Riduzione del numero di pagine di documentazione obsolete o non corrette
Di quali competenze ha bisogno un Technical Writer per lavorare su questo progetto?
- Vantaggio: esperienza nel controllo dei documenti
Volontari
Incoraggia i membri della community a registrarsi per aiutarli a svolgere 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 in caso di problemi o porre domande nel nostro forum. Includi link al tuo lavoro di scrittura tecnica o al tuo portfolio/curriculum/CV.
Informazioni correlate
- La pagina relativa a promozione e stampa include loghi e altri contenuti che puoi utilizzare quando parli della stagione di Documenti Google.
- Questo video di PyCon Australia 2017 offre suggerimenti su come organizzare la documentazione in modo che le persone la trovino utile: Che cosa dice nessuno sulla documentazione di Daniele Procida.