Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo progetto
- Organizzazione open source:
- Chat di gruppo open source di Zulip
- Technical Writer:
- drrosa
- Nome del progetto:
- Refactoring di ReadTheDocs e API Docs
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Mi concentrerò su due aree e lavorerò su di esse in parallelo. Uno di questi è migliorare la qualità di zulip.readthedocs.io in modo che i nuovi collaboratori si trovino a gestire meno confusione e dubbi lungo il percorso. Idealmente, il risultato sarà un percorso chiaro e conciso che dal primo contributo ti consentirà di acquisire familiarità con il funzionamento di Zulip. Inoltre, ho intenzione di lavorare su zulipchat.com/api, api.md e openapi.md per semplificare la comprensione della procedura di documentazione di endpoint aggiuntivi. È probabile che entrambe le parti riguardino l'aggiornamento/la semplificazione dei contenuti, la soppressione di articoli, l'aggiunta della documentazione dello sviluppatore mancante e anche la scrittura/il test del codice.
Il progetto sarà composto da quattro fasi. La prima fase includerà piccoli progetti di familiarizzazione, strumenti di preparazione e una migliore comprensione delle attuali esigenze di documentazione. Lo scopo della seconda fase sarà strutturare, specificare e dare la priorità al lavoro nel contesto degli obiettivi di Zulip in questa stagione autunnale. Poi passerò alla fase di implementazione del progetto. Mi metterò in contatto con i mentor e con il resto della community di sviluppatori di Zulip per ricevere feedback. La fase finale consisterà nel fare un bilancio, rivedere dove necessario e scrivere il report del progetto.
Sospetto che alcune priorità e attività potrebbero cambiare nel corso del periodo di lavoro a causa di ciò su cui stanno lavorando gli altri, incluse le decisioni prese dagli sviluppatori principali. Mi aspetto che imparare ad adattarsi bene a questi cambiamenti sarà un aspetto necessario per un'esperienza GSoD di successo. È possibile che a un certo punto abbia senso rimandare le idee proposte per un momento successivo. In generale, mi concentrerò sull'assicurarsi che il mio lavoro aiuti il successo complessivo del progetto open source Zulip.