Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Chat del team open source di Zulip
- Technical writer:
- Drrosa
- Nome progetto:
- Refactoring di ReadTheDocs e Documenti delle API
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Mi concentrerò su due aree e lavorerò su queste in parallelo. Uno di questi è migliorare la qualità di zulip.readthedocs.io in modo che i nuovi collaboratori riscontrino meno confusione e dubbi lungo il percorso. Idealmente, il risultato sarà un percorso chiaro e conciso che va da un primo contributo all'acquisizione di familiarità con il funzionamento di Zulip. Prevedo anche di lavorare su zulipchat.com/api, api.md e openapi.md per semplificare la comprensione del processo di documentazione di endpoint aggiuntivi. È probabile che entrambe le parti prevedano l'aggiornamento/la semplificazione dei contenuti, la cancellazione degli articoli, l'aggiunta di documentazione mancante per gli sviluppatori e anche la scrittura/test del codice.
Il progetto sarà suddiviso in quattro fasi. La prima fase includerà piccoli progetti di familiarizzazione, strumenti preparatori e una migliore comprensione delle attuali esigenze di documentazione. Lo scopo della seconda fase sarà strutturare, definire e dare priorità al lavoro nel contesto degli obiettivi di Zulip per il periodo autunnale. Poi passerò alla fase di implementazione del progetto. Farò avanti e indietro con i mentori e il resto della community di sviluppatori di Zulip per ricevere feedback. La fase finale sarà quella di guardare indietro, rivedere se necessario e scrivere il report del progetto.
Sospetto che alcune priorità e attività possano cambiare nel corso del periodo di lavoro in seguito alle attività su cui stanno lavorando tutti gli altri, comprese le decisioni prese dai principali sviluppatori. Prevedo che imparare ad adattarsi bene a questi cambiamenti sarà un aspetto necessario per avere un'esperienza GSoD di successo. È possibile che a un certo punto abbia senso rinviare le idee proposte per un secondo momento. In generale, mi assicurerò che il mio lavoro apporti valore al successo complessivo del progetto open source Zulip.