Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Creative Commons
- Technical writer:
- JackieBinya
- Nome progetto:
- Guida all'uso del tema di base di WordPress
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Durante la fase di candidatura per Technical Writer del GSOD-2020, ho avuto diverse interazioni con Hugo Solar, che è il mentore del progetto di documentazione di base di Creative Commons WordPress.
Durante il mio contatto iniziale, ho cercato di aiutarmi a comprendere gli obiettivi della creazione della guida all'uso del tema di base di WordPress. Mi è stato molto utile e mi ha aiutato rapidamente a iniziare il progetto. Tutte le interazioni consecutive che abbiamo avuto dopo riguardavano il perfezionamento degli obiettivi della documentazione del tema CC WordPress Base.
Quando ho raggiunto una fase ho capito di aver compreso i requisiti e gli obiettivi del progetto, quindi ho deciso di creare una bozza di proposta per la Guida all'utilizzo del tema di base di CC WordPress.
La proposta è stata creata utilizzando il modello ufficiale Creative Commons per le domande di tirocinio. Fornisce informazioni sulla sinossi del progetto, sulla struttura del progetto proposta e sul layout della nuova documentazione del tema di base di WordPress, nonché informazioni sulle tempistiche e sui risultati finali per la fase di creazione del documento.
Hugo Solar ha quindi esaminato la mia bozza di proposta e mi ha fornito un feedback per apportare miglioramenti. Durante questo processo, è stato sempre disponibile a rispondere alle domande sul progetto.
Ho implementato il feedback fornito e la mia proposta finale per la documentazione relativa alla creazione di documenti di D&I Badging è disponibile al link di seguito sotto forma di documento Google
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
In alternativa, un breve riepilogo della mia proposta, che trovi di seguito:
Creative Commons - Guida all'uso del tema di base WordPress Una proposta preparata da Jacqueline Binya, 28 giugno 2020
Sinossi del progetto L'obiettivo principale di questo progetto è creare una documentazione ricca, intuitiva, coinvolgente e ben presentata rivolta alla community per il tema di base di Creative Commons WordPress.
Piano del progetto Il problema Al momento, il tema base Creative Commons WordPress non dispone di documentazione e costituisce una barriera per un utilizzo efficace del tema all'interno della community. Il mio obiettivo è creare una guida all'uso completa del tema e implementare astrazioni nel codebase corrente del tema WP Base in modo da semplificare l'utilizzo del tema.
La soluzione Crea documenti futuristici utilizzando framework moderni come Gatsby. Gatsby ha dei comandi iniziali che possiamo utilizzare per eseguire il bootstrap della nuova documentazione del tema di base di WordPress. Un esempio di comando iniziale è gatsby-gitbook-starter, che è pronto all'uso e supporta l'ottimizzazione per i motori di ricerca (SEO), il 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'internazionalizzazione e l'accessibilità. Nel creare la documentazione, ho intenzione di renderla il più intuitiva possibile: - scrivendo la documentazione in modo facile da capire e facendo attenzione a evitare ambiguità e l'uso di un gergo tecnico troppo complesso. - incorporando illustrazioni grafiche ed elementi multimediali nella documentazione da usare come ausili visivi per l'apprendimento. - Utilizzando esempi che dimostrano come eseguire attività comuni, ad esempio le personalizzazioni.
Le astrazioni che spero di implementare includeranno garantire che la maggior parte delle funzionalità di base del tema di base WP, ad esempio gli hook, possano essere sfruttate dagli utenti dal pannello di amministrazione di WordPress. Inoltre, mi piacerebbe creare un tema figlio iniziale per il tema di base WP in un repository separato. Un tema secondario iniziale fornirà un'esperienza di onboarding più fluida e veloce ai nuovi utenti. Una volta che la documentazione sarà completa e approvata, verrà pubblicata e ospitata online.
La struttura proposta della Guida all'utilizzo del tema di base di CC WordPress - La documentazione proposta sarà divisa in diverse sezioni elencate di seguito. Gli elementi del sottoelenco sotto ogni sezione proposta forniscono quindi ulteriori dettagli sui contenuti effettivi che saranno disponibili nelle rispettive sezioni.
Sezione Panoramica - Descrivi la definizione, le intenzioni e le funzionalità del tema di base WordPress Creative Commons(CC). * Definizione: descrivi brevemente il tema di base del WP di CC. * Intenzioni: descrivi gli scopi/ intenzioni del tema di base del WP di CC * Funzionalità: descrivi le caratteristiche del tema di base del WP di CC
Sezione introduttiva - Requisiti * Descrivi i requisiti per l'installazione del tema di base WordPress CC, ovvero - Versione di WordPress - Versione PHP - Composer ecc. - Guida all'installazione * Descrivi come gli utenti possono utilizzare zip per installare il tema WordPress CC WordPress * Descrivi come gli utenti possono iniziare clonando il tema di base WP da GitHub. * Descrivere in che modo gli utenti possono installare le dipendenze nel progetto. * Spiega in che modo gli utenti possono configurare Queulat per le dipendenze. * 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 figlio * Indica i vantaggi dell'utilizzo di un tema figlio. * Comunica agli utenti che il modo consigliato per modificare il tema di base WP è utilizzare un tema secondario. * Evidenzia il fatto che il tema di base di WP deve essere installato e attivato prima che gli utenti possano creare un tema figlio.
Utilizzo di un tema secondario - Spiega in che modo gli utenti possono creare un tema secondario del tema di base WP utilizzando un comando iniziale. Utilizza un video per spiegare in che modo gli utenti possono creare un tema secondario dal comando iniziale.
Personalizzazione Nelle sottosezioni elencate di seguito illustreremo in che modo gli utenti possono utilizzare il parametro di personalizzazione di WordPress e il pannello di amministrazione di WordPress per effettuare le personalizzazioni. Integreremo anche l'uso di illustrazioni grafiche per rendere le nostre descrizioni più intuitive. - Personalizza la descrizione del sito o lo slogan. - Menu di navigazione personalizzati - Personalizza CSS - Aggiunta di pagine - Aggiunta di post - Widget - Aggiunta e rimozione di widget dal pannello di amministrazione di WordPress - Aggiunta di widget mediante il parametro di personalizzazione con anteprima in tempo reale
Sezione Personalizzazioni avanzate - Sezione Personalizzazione di CSS * Descrivi i componenti che costituiscono lo stile del tema: - CC Vocabolario - Bulma - Sass * Spiega come Sass è configurato 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 creare e guardare sass * Spiegare come gli utenti possono quindi personalizzare gli stili sass nel tema figlio, ovvero tramite l'installazione di dipendenze npm specifiche * Spiegare come viene utilizzata la classe dei componenti (class-component.php) per personalizzare gli stili dei componenti specifici
- Sezione ganci
Panoramica
- Spiegare il termine hook
- Spiega perché gli utenti dovrebbero sfruttare gli hook.
- Indica i tipi di hook disponibili.
Utilizzo delle azioni
- Elenca le azioni disponibili nel tema di base WP e il relativo posizionamento
- Spiega come possono essere implementate queste azioni.
*Uso dei filtri - Elenca i filtri disponibili nel tema e spiega come possono essere implementati
Sezione dell'aggiornamento del tema - Spiega in che modo gli utenti possono aggiornare il tema.
Sezione sulle licenze * Spiega le licenze del progetto e cosa significa per le persone che potrebbero voler utilizzare il tema di base CC WP nei loro progetti personali.
Sezione per i contributi * Aggiungi una guida dettagliata * Descrivi il codice di condotta * Community: fornisci informazioni sui canali della community Creative Commons e su come i collaboratori possono partecipare e così via.