Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- Creative Commons
- Technical Writer:
- JackieBinya
- Nome del progetto:
- Guida all'utilizzo del tema base di WordPress
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Durante la fase di candidatura per il ruolo di Technical Writer del GSOD-2020, ho avuto diversi contatti con Hugo Solar, il mentore del progetto di documentazione del tema base di WordPress di Creative Commons.
Nel mio primo contatto con lui, ho chiesto aiuto per comprendere gli obiettivi della creazione della guida all'utilizzo del tema base di WordPress. È stato molto disponibile e mi ha coinvolto rapidamente nel progetto. Tutte le interazioni consecutive che abbiamo avuto in seguito riguardavano il perfezionamento degli scopi della documentazione del tema base WordPress di CC.
Quando ho raggiunto una fase in cui sentivo di aver compreso i requisiti e gli obiettivi del progetto, ho creato una bozza di proposta per la Guida all'utilizzo del tema base WordPress di CC.
La proposta è stata creata utilizzando il modello ufficiale Creative Commons per le domande di stagista. Fornisce informazioni sulla sinossi del progetto, sulla struttura del progetto proposta e sul layout della documentazione del nuovo tema base WordPress, nonché informazioni su tempistiche e risultati della fase di creazione del documento.
Hugo Solar ha poi esaminato la bozza della mia proposta e mi ha fornito un feedback per apportare miglioramenti. Durante tutto il processo, è sempre stato disponibile a rispondere alle domande sul progetto.
Ho implementato il feedback fornito e la mia proposta finale per la documentazione relativa ai badge per la creazione di contenuti inclusivi è disponibile nel link di seguito sotto forma di documento Google
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
In alternativa, di seguito trovi un breve riepilogo della mia proposta:
Creative Commons - Guida all'utilizzo del tema di base WordPress Una proposta preparata da Jacqueline Binya, 28 giugno 2020
Sinossi del progetto L'obiettivo finale di questo progetto è creare una documentazione completa, intuitiva, coinvolgente e ben presentata per la community per il tema base di WordPress di Creative Commons.
Progetto Il problema Al momento, il tema di base WordPress di Creative Commons non ha documentazione, il che rappresenta un ostacolo per l'utilizzo efficace del tema all'interno della community. Il mio obiettivo è creare una guida all'utilizzo completa per il tema e implementare delle astrazioni nel codebase corrente del tema WP Base, in modo da facilitarne l'utilizzo.
La soluzione Crea documenti futuristici utilizzando framework moderni come Gatsby. Gatsby ha dei comandi iniziali che possiamo usare per eseguire il bootstrap della nuova documentazione relativa ai temi di base di WordPress. Un esempio di comando iniziale è gatsby-gitbook-starter, che è supportato per l'ottimizzazione per i motori di ricerca (SEO), Markdown e Algolia ( uno strumento utilizzato per l'integrazione per la ricerca nei siti statici). Inoltre, qualsiasi sito generato da Gatsby può essere facilmente ottimizzato per integrare l'accessibilità e l'internazionalizzazione. Quando creo la documentazione, il mio obiettivo è renderla il più intuitiva possibile: - scrivendo i documenti in modo facile da capire e facendo attenzione a evitare ambiguità e l'uso di un gergo tecnico eccessivamente complesso. - incorporando illustrazioni e contenuti multimediali nella documentazione da utilizzare come ausili visivi per l'apprendimento. - utilizzando esempi che mostrano come eseguire attività comuni, ad esempio le personalizzazioni.
Le astrazioni che spero di implementare includeranno la garanzia che la maggior parte delle funzionalità di base del tema di base del WP, ad esempio gli hook, possa essere utilizzata dagli utenti dal pannello di amministrazione di WordPress. Inoltre, mi piacerebbe creare un tema secondario di base per il tema di base WP in un repository separato. Avere un tema secondario iniziale offrirebbe un'esperienza di onboarding più fluida e veloce per i nuovi utenti. Una volta completata e approvata la documentazione, verrà pubblicata e ospitata online.
La struttura proposta della Guida all'utilizzo del tema base WordPress di CC - La documentazione proposta sarà suddivisa nelle diverse sezioni elencate di seguito. Gli elementi dell'elenco secondario di ogni sezione proposta forniscono ulteriori dettagli sui contenuti effettivi che verranno trovati nelle rispettive sezioni.
Sezione Panoramica - Delinea la definizione, le intenzioni e le funzionalità del tema base WordPress di Creative Commons(CC). * Definizione: descrivi brevemente il tema base CC WP. * Intentions: illustra gli scopi/ le intenzioni del tema base CC WP * Features: illustra le funzionalità del tema base CC WP
Sezione Iniziazione - Requisiti * Indica i requisiti per l'installazione del tema base WordPress di CC, ad esempio: - Versione di WordPress - Versione di PHP - Composer e così via. - Guida all'installazione * Indica come gli utenti possono utilizzare il file ZIP per installare il tema WordPress di CC * Indica come gli utenti possono iniziare a utilizzare il tema base WP clonandolo da GitHub. * Indica in che modo gli utenti possono installare le dipendenze nel progetto. * Spiega come gli utenti possono configurare la dipendenza Queulat. * Spiega in che modo gli utenti possono attivare il tema nel loro ambiente di sviluppo WordPress locale.
Guida all'utilizzo - Panoramica * Spiega il termine tema secondario * Indica i vantaggi dell'utilizzo di un tema secondario. * Informa gli utenti che il modo consigliato per modificare il tema WP Base è tramite un tema secondario. * Metti in evidenza il fatto che il tema base WP deve essere installato e attivato prima che gli utenti possano creare un tema secondario.
Utilizzo di un tema secondario - Spiega in che modo gli utenti possono creare un tema secondario del tema di base WP con un comando iniziale. Utilizza un video per spiegare agli utenti come creare un tema secondario dal tema iniziale.
Personalizzazione Nelle sottosezioni elencate di seguito, descriviamo in che modo gli utenti possono utilizzare il Personalizzatore di WordPress e il pannello di amministrazione di WordPress per apportare personalizzazioni. Inoltre, integreremo l'uso di illustrazioni grafiche per rendere le nostre descrizioni più intuitive. - Personalizza la descrizione o il tagline del sito. - Menu di navigazione personalizzati - Personalizza CSS - Aggiunta di pagine - Aggiunta di post - Widget - Aggiungere e rimuovere i widget dal pannello di amministrazione di WordPress - Aggiungere i widget utilizzando il Personalizzatore con anteprima in tempo reale
Sezione Personalizzazioni avanzate - Sezione Personalizzazione CSS * Descrivi i componenti che costituiscono lo stile del tema: - Vocabulary CC - Bulma - Sass * Spiega come è configurato Sass nel progetto. La spiegazione deve includere informazioni su: (i) la posizione dei file Sass nella struttura del progetto (ii) gli script npm che possono essere utilizzati per compilare e monitorare Sass * Spiega come gli utenti possono personalizzare gli stili Sass nel tema secondario, ad esempio tramite l'installazione di dipendenze npm specifiche * Spiega come la classe del componente (class-component.php) viene utilizzata per personalizzare gli stili di componenti specifici
- Sezione Ganci
Panoramica
- Spiegare il termine hook
- Spiega perché gli utenti dovrebbero utilizzare gli hook.
- Delinea i tipi di ganci disponibili.
Utilizzare le azioni
- Elenca le azioni disponibili nel tema WP Base e il relativo posizionamento
- Spiega come possono essere implementate queste azioni.
*Utilizzo dei filtri - Elenca i filtri disponibili nel tema e spiega come possono essere implementati
Aggiornamento del tema - Spiega come gli utenti possono aggiornare il tema.
Sezione Licenze * Spiega le licenze del progetto e cosa significano per le persone che potrebbero voler utilizzare il tema di base CC WP nei loro progetti personali.
Sezione relativa ai contributi * Aggiungi una guida dettagliata per i collaboratori * Illustra il Codice di condotta * Community: fornisci informazioni sui canali della community di Creative Commons e su come i collaboratori possono partecipare e così via.