Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Django
- Technical writer:
- Gabbyprecious
- Nome progetto:
- La guida ai contributi Riscrivi per renderla più intuitiva e facile da esplorare
- Durata del progetto:
- Durata standard (3 mesi)
Project description
SINTESI
L'obiettivo della guida ai contributi di Django, come ogni altra documentazione, è guidare gli utenti e i collaboratori open source in questo caso su come e dove possono contribuire a rendere Django migliore e sostenibile.
C'è sempre la necessità di creare documenti, soprattutto una che ha un impatto enorme sulla community e su Django stessa.
L'obiettivo di Django per l'estate di Documenti Google di quest'anno è rendere la guida ai contributi meno difficile, accessibile e accogliente per i collaboratori. Si tratta di un obiettivo essenziale in quanto incoraggia i collaboratori, a cui appartengo io per iniziare a contribuire a questo fantastico framework.
Stato attuale
La fase attuale della documentazione, che si trova qui, non è una guida significativa in quanto è troppo impegnativa e non ben strutturata e porta a una minore comprensione dei contributi in Django e a non accogliere nuovi collaboratori.
Obiettivi del progetto
Ho discusso dei miei suggerimenti per la documentazione con il mio mentore, Carlton Gibson, nel forum e lui approva che la documentazione mi aiuterà a risolvere il problema enorme con la documentazione attuale. Ecco gli obiettivi che ho in programma di ristrutturare il documento: Ristrutturare il documento Aggiungere le cose da fare e da non fare in sezioni Creare pagine singole per sezioni banali come la richiesta e la creazione di funzionalità Documentazione ridotta e diretta Glossario per le parole Indice interno creato per seguire la nuova guida Scrivere una documentazione più facile da identificarsi Suddividi i contenuti in due parti principali (sezione per principianti e collaboratori avanzati per seguire gli standard tecnici per i nuovi collaboratori e la sezione per collaboratori avanzati e per gli autori
La documentazione attuale è già rivolta ai collaboratori esperti e non dà la possibilità a collaboratori principianti e principianti sia di utilizzare l'open source che con Django. Di seguito sono riportati alcuni contenuti aggiuntivi per principianti: Sezione che guida i diversi gruppi di collaboratori(writer tecnici, designer e sviluppatori) Una pagina che documenta i problemi dei primi timer e i problemi semplici che possono essere risolti. Prendi alcune sezioni della documentazione attuale, riscrivile e aggiungile alla sezione per principianti. Sezioni che illustrano i punti o le parole chiave utilizzati nella sezione avanzata.
Sequenza
Ecco una suddivisione su come voglio lavorare sull'obiettivo del progetto elencato sopra con il calendario fornito da Google.
Settimana delle relazioni con la community( 17 agosto - 13 settembre) Inizia a collaborare di più con la community Continua a contribuire alla documentazione Ricevere più suggerimenti dai collaboratori Ulteriori studi sulla documentazione attuale e sugli strumenti previsti Settimana 1 - Settimana 4 Iniziare a sezionare la documentazione in base ai Livelli Creare la sezione per principianti della documentazione Settimana 4 - 6 Guida alla scelta dei collaboratori e dei Glossario della settimana
Strumenti
Sphinx: strumento attuale per la documentazione corrente. Leggi la documentazione.
Perché questo progetto?
Credo fortemente nella documentazione e negli articoli ben scritti per coinvolgere chiunque in una parte del mondo. A parte questo, sono anche amante di Django e dell'open source nel complesso. Volevo contribuire a Django da principiante e penso che questo sia un modo perfetto per dare il mio contributo al mio strumento preferito e, allo stesso tempo, conoscere il codebase per offrire più contributi come sviluppatore(e Technical Writer). Sarà bello e piacevole lavorare con un'organizzazione in linea con le mie opinioni e che è stato un ottimo strumento per tutta la mia carriera.
Perché sono la persona giusta per questo progetto?
Credo di essere la persona giusta in base ai seguenti account: Ho dato il mio contributo a Django scrivendo articoli che aiutano i principianti a capire meglio il concetto di Django. Essendo uno sviluppatore che non vede l'ora di contribuire a Django, comprendo l'esigenza di altri sviluppatori e come documentarli bene per loro. Lavoro in squadra e lavorerò sotto la supervisione del mio mentore Carlton Gibson.