Share
Deci, acum aveți un cadru tematic WordPress. Felicitări! Munca grea pe care ați pus-o în curs de dezvoltare va fi plătită pe termen lung și va face ca procesul de dezvoltare să se sufoce, să fie mai raționalizat și mai eficient.
Dar trebuie să faceți un ultim lucru înainte de a termina, și asta pentru a documenta cadrul dvs. Cel puțin va trebui să vă asigurați că ați folosit comentarii bune în întregul cod, dar este, de asemenea, util să scrieți o altă documentație, astfel încât să puteți urmări fișierele, funcțiile și filtrele care alcătuiesc API-.
Opțiunile pe care le voi acoperi sunt:
Rețineți că în timp ce voi menționa câteva instrumente de documentare, acest tutorial nu servește drept recomandare, deoarece nu le-am folosit pentru propriul meu cadru, deci va trebui să vă faceți propria judecată cu privire la adecvarea lor.
Comentariile sunt deosebit de importante atunci când alți dezvoltatori vor lucra cu codul dvs. (de exemplu, dacă sunteți parte dintr-o echipă sau dacă vă veți elibera cadrul). Dar ele sunt, de asemenea, neprețuite dacă lucrați pe cont propriu, deoarece este foarte ușor să uitați exact ce face o bucată de cod atunci când veniți să o editați timp de un an sau mai mult pe linie.
Imaginați-vă că ați folosit cadrul dvs. pentru a construi un site client. Doi ani de acum, site-ul dezvoltă o problemă la ora 5:30 într-o după-amiază vineri. Comentariile bune pot face diferența între rezolvarea rapidă a problemelor și acasă pentru weekend, în comparație cu slogging-ul prin sute de linii de cod și lipsesc de vineri noaptea.
Iată câteva sfaturi pentru comentarii bune:
Accentsconagua
@pachet) și ce versiune a temei a fost în vigoare de la (@de cand). Ar trebui să utilizați un sistem similar pentru fișierele plugin./ ** * Nume de șablon: sidebar-products.php * * Fișierul de includere utilizat pentru bara laterală în paginile care utilizează șablonul single-product.php. Afișează o galerie de imagini de produse (omiterea imaginii prezentate care este afișată în conținut). * * @package wpptl-theme-framework * @ de la versiunea 1.0 * /
A readme.txt fișierul este nivelul următor după comentare. Este un singur fișier pe care îl includeți în tema dvs., conținând informații despre temă.
Bundle de cod pentru a însoți această serie include un simplu readme.txt fişier:
Crearea propriului cadru tematic WordPress Această temă acceptă partea a șasea a acestei serii pentru wptutsplus. Tema include următoarele fișiere șablon: arhive.php index.php page.php - pentru pagini statice page-full-width.php arhive.php - pentru pagini de arhivă header.php sidebar.php footer.php loop.php loop-single .php loop-page.php functions.php Tema acceptă imagini, meniuri și widget-uri speciale și le folosește după cum urmează: Imagini recomandate: Acestea sunt afișate în șabloanele de arhivă și index dacă sunt prezente, utilizând dimensiunea medie. Meniuri: Meniul implicit este în header.php și folosește Menus admin styling Tema utilizează Object Oriented CSS (OOCSS). Următoarele clase sunt pentru aspect și le puteți utiliza în paginile și postările dvs. Ele sunt receptive, astfel încât acestea vor fi redimensionate pe ecrane mai mici (de exemplu, clasa .half este lățimea totală a telefoanelor). Întregul lățimea este de trei sferturi. Două treimi .half.third.quarter Cârlige Există 7 cârlige de acțiune: deasupra header În interiorul antetului Înainte de conținut După conținut În bara laterală În subsol După subsol Există 3 cârlige de filtru: 1 în antetul 2 în subsolul Widget Areas Există șase domenii widget, toate adăugate prin fișierul widgets.php: - unul în antet - unul în bara laterală - patru în subsol
Dacă vrei să te faci Citește-mă fișier mai ușor de utilizat, poate doriți să luați în considerare crearea unui readme.html fișier care se va deschide în browserul unui utilizator. Puteți utiliza CSS pentru a marca dvs. Citește-mă fișier și să fie mai ușor de citit.
Dacă doriți să lansați tema publicului prin intermediul magazinului tematic WordPress, va trebui să furnizați o readme.txt fișier ca formă minimă de documentație. Voi prezenta acest lucru în detaliu în tutorialul final din această serie, cu privire la lansarea cadrului tematic.
Dacă intenționați să continuați să vă dezvoltați cadrul și nu doriți să petreceți mult timp manual pentru a scrie documentația pentru fiecare caracteristică nouă, poate fi un instrument de documentație automat.
Cele mai multe dintre acestea implică utilizarea de etichete sau sintaxe specifice pentru a permite sistemului să identifice unde să genereze documentația. Exemplele includ:
Dacă intenționați să utilizați unul dintre aceste instrumente, merită să petreceți ceva timp pentru a identifica cel mai bun pentru dvs. înainte de a începe, deoarece nu veți putea transfera documentația de la unul la altul.
Dar odată ce v-ați confruntat cu sistemul și l-ați configurat, un instrument automat, cum ar fi acestea, vă poate economisi mult timp și poate evita lacunele din documentația dvs. pe linie, deoarece veți fi atât de ocupați scriind codul nu aveți timp să vă actualizați docs-urile.
Această opțiune va fi mai multă muncă și merită făcută doar dacă vă vedeți că cadrul dvs. crește în timp și câștigă o bază de utilizatori semnificativă. Toate cadrele tematice majore au propriile site-uri web cu documentație, care este fie accesibilă în mod liber, fie accesibilă numai membrilor.
Site-ul web care vă sprijină cadrul ar putea fi o parte a strategiei dvs. de generare de bani - cadrul tematic hibrid, de exemplu, este gratuit, însă documentația și suportul pe site-ul său de însoțire sunt disponibile abonaților plătitori.
În mod alternativ, dacă eliberați cadrul dvs. ca produs premium, ați putea solicita abonaților să vă conectați la documente sau puteți alege publicarea documentației dvs., cu speranța că va încuraja mai mulți oameni să cumpere.
Dacă cadrul dvs. este complet gratuit, puteți alege să creați un site web gratuit cu documentație, cum este cazul cu cadrul Wonderflux:
În mod alternativ, puteți decide să creați un wiki, ceea ce are avantajul de a permite utilizatorilor să contribuie la docs. În cele mai multe cazuri, acest lucru va necesita mai mult timp decât un site web, dar ar putea fi un instrument valoros pentru comunitatea care utilizează cadrul dvs. Puteți crea un wiki utilizând un plugin pentru site-ul WordPress al cadrului dvs..
Tutorialele pot ajuta noii utilizatori, în special cei care nu pot scrie coduri, să se ocupe de cadrul dvs. mai rapid decât documentația standard. Videoclipurile fac acest pas înainte, oferind un ghid vizual ușor de utilizat și un instrument de marketing excelent.
Cadrul Genesis are o serie de tutoriale pentru utilizatori, care sunt disponibile numai pentru abonații plătiți:
Cadrul meu Edupress are un număr de videoclipuri video tutorial pe care le-am creat pentru a ajuta utilizatorii cu un grad diferit de experiență pe calculator și puțină experiență în utilizarea WordPress:
Acestea sunt afișate pe site-ul web public și, de asemenea, în tablourile de bord ale utilizatorilor, astfel încât să poată accesa cu ușurință în timp ce lucrează cu cadrul. Dacă creați documentație, tutoriale sau videoclipuri pentru cadrul dvs., este posibil să includeți un ecran în tabloul de bord cu detalii despre documentele dvs..
Cu toate acestea, crearea de tutoriale sau clipuri video este foarte consumatoare de timp și are nevoie de multă muncă pentru a avea dreptate: tutorialele scrise greșit sau videoclipurile slab dezvoltate se vor reflecta prost în cadrul dvs. și vă pot face mai mult rău decât o formă mai simplă de documentare.
Oricine va folosi cadrul dvs. tematic, este esențial să existe un fel de documentație. Indiferent dacă dezvoltați doar cadrul pentru dvs. și echipa dvs. sau dacă îl eliberați pentru o utilizare mai largă, va trebui să înregistrați informații despre structura fișierului și API-ul.
Opțiunile pe care le-am discutat mai sus variază de la comentariile simple la cele mai complexe, cu totul între ele. Ceea ce decideți să faceți va depinde de nevoile utilizatorilor dvs. și se poate schimba în timp pe măsură ce câștigați o bază de utilizatori mai mare.
