Share
Quindi, ora hai un framework per tema WordPress. Congratulazioni! Il duro lavoro che hai svolto per svilupparlo ti ripagherà a lungo termine e renderà il tuo processo di sviluppo più soffice, più snello e più efficiente.
Ma devi fare un'ultima cosa prima che tu abbia finito, e questo è per documentare la tua struttura. Per lo meno dovrai assicurarti che il buon commento venga usato per tutto il codice, ma è anche utile scrivere qualche altra documentazione in modo da poter tenere traccia dei file, delle funzioni e dei filtri che costituiscono l'API del tuo framework.
Le opzioni che coprirò sono:
Si noti che mentre menzionerò alcuni strumenti di documentazione, questo tutorial non è utile come raccomandazione poiché non li ho usati per il mio framework, quindi è necessario dare il proprio giudizio sulla loro idoneità.
I commenti sono particolarmente importanti quando altri sviluppatori lavoreranno con il tuo codice (ad esempio se fai parte di una squadra o se rilascerai il tuo framework). Ma sono anche di valore inestimabile se lavori da solo, dato che è molto facile dimenticare esattamente cosa fa un codice quando si arriva a modificarlo un anno o più lungo la linea.
Immagina di aver usato il tuo framework per costruire un sito client. Tra due anni, il sito svilupperà un problema alle 5:30 di un venerdì pomeriggio. I buoni commenti possono fare la differenza tra risolvere rapidamente i problemi ed essere a casa per il fine settimana, rispetto alla ricerca di centinaia di righe di codice e la mancanza del venerdì sera.
Ecco alcuni suggerimenti per buoni commenti:
Accentsconagua
@pacchetto), e quale versione del tema è stata in vigore da (@da). Dovresti usare un sistema simile per i file plugin./ ** * Nome modello: sidebar-products.php * * Il file include utilizzato per la barra laterale sulle pagine utilizzando il modello single-product.php. Visualizza una galleria di immagini del prodotto (omettendo l'immagine in primo piano che viene visualizzata nel contenuto). * * @package wpptl-theme-framework * @since versione 1.0 * /
UN readme.txt il file è il livello successivo dopo aver commentato. È un singolo file che includi nel tuo tema, contenente informazioni sul tema.
Il pacchetto di codice che accompagna questa serie include un semplice readme.txt file:
Creazione del tuo tema framework per WordPress Questo tema supporta la sesta parte di questa serie per wptutsplus. Il tema include i seguenti file modello: archive.php index.php page.php - per pagine statiche page-full-width.php archive.php - per pagine di archivio header.php sidebar.php footer.php loop.php loop-single .php loop-page.php functions.php Il tema supporta immagini, menu e widget in primo piano e li utilizza come segue: Immagini in vetrina: sono visualizzate nei modelli di archivio e di indice, se presenti, utilizzando la dimensione media. Menu: il menu predefinito è in header.php e utilizza i menu Admin styling Il tema utilizza i CSS orientati agli oggetti (OOCSS). Le seguenti clases sono per il layout e puoi usarle nelle tue pagine e nei tuoi post. Sono reattivi, quindi verranno ridimensionati su schermi più piccoli (ad esempio la classe .half è piena larghezza sui telefoni) .full-width .three-quarter .two-thirds .half .third .quarter hooks Ci sono 7 hook di azione: above the intestazione All'interno dell'intestazione Prima del contenuto Dopo il contenuto Nella barra laterale Nel piè di pagina Dopo il piè di pagina Sono presenti 3 ganci filtro: 1 nell'intestazione 2 nel piè di pagina Aree widget Sono presenti sei aree widget, tutte aggiunte tramite il file widgets.php: - Uno nell'intestazione - uno nella barra laterale - quattro nel footer
Se vuoi fare il tuo readme file più user-friendly, si potrebbe voler considerare la creazione di un readme.html file invece che si aprirà nel browser dell'utente. Puoi usare i CSS per marcare il tuo readme file e renderlo più facile da leggere.
Se si desidera rilasciare il tema al pubblico tramite il repository di temi WordPress, è necessario fornire un readme.txt file come una forma minima di documentazione. Tratterò questo argomento in modo più dettagliato nel tutorial finale di questa serie, sul rilascio del framework del tema.
Se si intende continuare a sviluppare il framework e non si vuole dedicare molto tempo alla scrittura manuale della documentazione per ogni nuova funzionalità, uno strumento di documentazione automatizzato potrebbe essere la risposta.
La maggior parte di questi comporta l'utilizzo di tag o sintassi specifici per consentire al sistema di identificare dove generare la documentazione. Esempi inclusi:
Se stai per utilizzare uno di questi strumenti, vale la pena dedicare del tempo a identificare il migliore per te prima di iniziare, poiché non sarai in grado di trasferire la tua documentazione da uno all'altro.
Ma una volta che hai preso confidenza con il sistema e l'hai configurato, uno strumento automatico come questo può farti risparmiare un sacco di tempo e può evitare lacune nella documentazione lungo la linea, dato che sarai così impegnato a scrivere codice non ho tempo per aggiornare i tuoi documenti.
Questa opzione sarà più utile e vale la pena fare solo se vedi che il tuo framework cresce nel tempo e guadagna una base di utenti significativa. Tutti i principali framework tematici hanno i propri siti Web con documentazione, che è liberamente accessibile o disponibile solo per i membri.
Il sito Web per supportare il tuo framework potrebbe far parte della tua strategia di monetizzazione: il framework a tema ibrido, per esempio, è gratuito, ma la documentazione e il supporto sul suo sito web di accompagnamento sono disponibili solo per gli abbonati paganti.
In alternativa, se stai pubblicando il tuo framework come prodotto premium, potresti richiedere agli abbonati di accedere ai documenti, o potresti scegliere di rendere pubblica la tua documentazione nella speranza che incoraggi più persone ad acquistare.
Se il tuo framework è completamente gratuito, puoi scegliere di creare un sito web gratuito con la documentazione, come nel caso del framework Wonderflux:
In alternativa, potresti decidere di creare un wiki, che ha il vantaggio di consentire agli utenti di contribuire ai documenti. Nella maggior parte dei casi questo richiederà più tempo per la configurazione di un sito Web, ma potrebbe essere uno strumento prezioso per la comunità che utilizza il framework. Puoi creare una wiki usando un plugin per il sito WordPress del tuo framework.
Le esercitazioni possono aiutare i nuovi utenti, in particolare quelli che non possono scrivere codice, a familiarizzare con il framework più rapidamente della documentazione standard. I video fanno un ulteriore passo avanti, fornendo una guida visiva facile da usare e un ottimo strumento di marketing.
Il framework Genesis ha una gamma di tutorial per gli utenti che sono disponibili solo per gli abbonati a pagamento:
Il mio framework Edupress ha una serie di video tutorial che ho creato per aiutare gli utenti con un diverso grado di esperienza del computer e poca esperienza nell'uso di WordPress:
Questi vengono visualizzati sul sito Web pubblico e anche nei cruscotti degli utenti in modo che possano facilmente accedervi mentre lavorano con il framework. Se crei documentazione, esercitazioni o video per il tuo framework, potresti includere uno schermo nel dashboard con i dettagli dei tuoi documenti.
Tuttavia, la creazione di tutorial o video richiede molto tempo e richiede molto lavoro per essere corretta: esercitazioni scritte male o video prodotti in modo errato riflettono in modo errato sul tuo framework e potrebbero causare più danni di una semplice forma di documentazione.
Chiunque userà la tua cornice tematica, una sorta di documentazione è essenziale. Sia che tu stia solo sviluppando il framework per te e il tuo team, sia che lo rilasci per un uso più ampio, dovrai registrare le informazioni sulla struttura del file e sull'API.
Le opzioni che ho discusso in precedenza vanno dai semplici commenti ai video più complessi, con tutto il resto. Ciò che decidi di fare dipenderà dalle esigenze dei tuoi utenti e potrebbe cambiare nel tempo man mano che acquisirai una base di utenti più ampia.
