Share
So haben Sie jetzt ein WordPress-Theme-Framework. Herzliche Glückwünsche! Die harte Arbeit, die Sie in die Entwicklung gesteckt haben, wird sich langfristig auszahlen und Ihren Entwicklungsprozess glatter, effizienter und effizienter gestalten.
Aber bevor Sie fertig sind, müssen Sie noch ein letztes tun, um Ihren Rahmen zu dokumentieren. Zumindest müssen Sie sicherstellen, dass im gesamten Code gute Kommentare verwendet werden. Es ist jedoch auch hilfreich, eine andere Dokumentation zu schreiben, damit Sie die Dateien, Funktionen und Filter der API des Frameworks nachverfolgen können.
Die Optionen, die ich behandeln werde, sind:
Obwohl ich ein paar Dokumentationswerkzeuge erwähne, dient dieses Tutorial nicht als Empfehlung, da ich sie nicht für mein eigenes Framework verwendet habe. Daher müssen Sie sich selbst ein Urteil über ihre Eignung machen.
Kommentare sind besonders wichtig, wenn andere Entwickler mit Ihrem Code arbeiten (z. B. wenn Sie Teil eines Teams sind oder wenn Sie Ihr Framework veröffentlichen). Sie sind aber auch von unschätzbarem Wert, wenn Sie alleine arbeiten, denn es ist sehr leicht zu vergessen, was ein Stück Code macht, wenn Sie ihn ein Jahr oder später bearbeiten.
Stellen Sie sich vor, Sie haben Ihr Framework zum Erstellen einer Client-Site verwendet. In zwei Jahren entwickelt die Website an einem Freitagnachmittag um 5:30 Uhr ein Problem. Gute Kommentare können den Unterschied zwischen einer schnellen Behebung der Probleme und einem Wochenendaufenthalt ausmachen, statt sich durch hunderte von Codezeilen zu kämpfen und den Freitagabend zu verpassen.
Hier sind einige Tipps für gute Kommentare:
Accentsconagua
@Paket) und welche Version des Themas es seit (@schon seit). Sie sollten ein ähnliches System für Plugin-Dateien verwenden./ ** * Vorlagenname: sidebar-products.php * * Die Include-Datei, die für die Seitenleiste auf Seiten verwendet wird, die die Vorlage "single-product.php" verwenden. Zeigt eine Galerie von Produktbildern an (wobei das im Inhalt angezeigte Bild weggelassen wird). * * @package wpptl-theme-framework * @since Version 1.0 * / /
EIN readme.txt Datei ist die nächste Ebene nach dem Kommentieren. Es ist eine einzelne Datei, die Sie in Ihr Design aufnehmen und Informationen über das Design enthalten.
Das Code-Bundle zu dieser Serie enthält eine einfache readme.txt Datei:
Erstellen eines eigenen WordPress-Theme-Frameworks Dieses Design unterstützt den 6. Teil dieser Serie für wptutsplus. Das Design enthält die folgenden Vorlagendateien: archive.php index.php page.php - für statische Seiten page-full-width.php archive.php - für Archivseiten header.php sidebar.php footer.php loop.php loop-single .php loop-page.php functions.php Das Design unterstützt ausgewählte Bilder, Menüs und Widgets und verwendet diese wie folgt: Hervorgehobene Bilder: Diese werden in den Archiv- und Indexvorlagen angezeigt, sofern vorhanden, und zwar in mittlerer Größe. Menüs: Das Standardmenü befindet sich in header.php und verwendet die Menüs admin Styling Das Design verwendet objektorientiertes CSS (OOCSS). Die folgenden Klassen dienen zum Layout und können in Ihren Seiten und Beiträgen verwendet werden. Sie sind ansprechbar und werden daher auf kleineren Bildschirmen skaliert (z. B. ist die .half-Klasse bei Mobiltelefonen die volle Breite). Volle Breite. Drei Viertel. Zwei Drittel. Halb. Dritte .Quarter Hooks. Es gibt 7 Aktionshaken: Über dem header Innerhalb des Headers Vor dem Inhalt Nach dem Inhalt In der Seitenleiste In der Fußzeile Nach der Fußzeile Es gibt 3 Filterhaken: 1 in der Kopfzeile 2 in der Fußzeile Widget-Bereiche Es gibt sechs Widget-Bereiche, die alle über die Datei 'Widgets.php' hinzugefügt werden: - Eine in der Kopfzeile - Eine in der Seitenleiste - Vier in der Fußzeile
Wenn du dein machen willst Readme Datei benutzerfreundlicher, möchten Sie vielleicht die Erstellung einer readme.html Datei stattdessen, die im Browser eines Benutzers geöffnet wird. Sie können CSS zum Markieren Ihres verwenden Readme Datei und machen es einfacher zu lesen.
Wenn Sie Ihr Theme über das WordPress-Theme-Repository der Öffentlichkeit zur Verfügung stellen möchten, wird von Ihnen erwartet, dass Sie ein readme.txt Datei als Mindestdokumentation. Im letzten Tutorial dieser Serie werde ich ausführlicher darauf eingehen, wie Sie Ihr Theme-Framework veröffentlichen.
Wenn Sie beabsichtigen, Ihr Framework weiterzuentwickeln und nicht viel Zeit für das manuelle Erstellen der Dokumentation für jedes neue Feature aufwenden möchten, könnte ein automatisiertes Dokumentationswerkzeug die Antwort sein.
Bei den meisten davon müssen bestimmte Tags oder Syntax verwendet werden, damit das System ermitteln kann, wo die Dokumentation erstellt werden soll. Beispiele beinhalten:
Wenn Sie eines dieser Tools verwenden, lohnt es sich, vor dem Start das beste für Sie zu ermitteln, da Sie Ihre Dokumentation nicht von einem auf den anderen übertragen können.
Wenn Sie sich jedoch erst einmal mit dem System auseinandergesetzt und es eingerichtet haben, können Sie mit einem solchen automatisierten Tool viel Zeit sparen und Lücken in Ihrer Dokumentation vermeiden, da Sie damit beschäftigt sind, Code zu schreiben Sie haben keine Zeit, Ihre Dokumente zu aktualisieren.
Diese Option wird mehr Arbeit erfordern und ist nur dann sinnvoll, wenn Sie feststellen, dass Ihr Framework im Laufe der Zeit wächst und eine bedeutende Benutzerbasis entsteht. Alle wichtigen Themenframeworks verfügen über eigene Websites mit Dokumentation, die entweder frei zugänglich sind oder nur den Mitgliedern zur Verfügung stehen.
Die Website zur Unterstützung Ihres Frameworks könnte Teil Ihrer Monetarisierungsstrategie sein - das Hybrid-Theme-Framework ist beispielsweise kostenlos, die Dokumentation und der Support auf der dazugehörigen Website stehen jedoch nur zahlenden Abonnenten zur Verfügung.
Wenn Sie Ihr Framework als Premiumprodukt veröffentlichen, können Sie alternativ verlangen, dass sich die Abonnenten bei den Dokumenten anmelden, oder Sie möchten Ihre Dokumentation öffentlich machen, in der Hoffnung, dass dadurch mehr Menschen zum Kauf animiert werden.
Wenn Ihr Framework völlig kostenlos ist, können Sie, wie beim Wonderflux-Framework, eine kostenlose Website mit Dokumentation erstellen:
Alternativ können Sie auch ein Wiki erstellen, das den Vorteil hat, dass Ihre Benutzer sich an den Dokumenten beteiligen können. In den meisten Fällen dauert die Einrichtung mehr Zeit als eine Website, kann jedoch für die Community, die Ihr Framework verwendet, ein wertvolles Werkzeug sein. Sie können ein Wiki mit einem Plugin für die WordPress-Site Ihres Frameworks erstellen.
Mit Hilfe von Tutorials können neue Benutzer, insbesondere solche, die keinen Code schreiben können, schneller mit dem Framework vertraut gemacht werden als mit der Standarddokumentation. Videos gehen noch einen Schritt weiter und bieten eine einfach zu verwendende visuelle Anleitung und ein großartiges Marketinginstrument.
Das Genesis-Framework bietet eine Reihe von Tutorials für Benutzer, die nur kostenpflichtigen Abonnenten zur Verfügung stehen:
Mein eigenes Edupress-Framework enthält eine Reihe von Lernvideos, die ich erstellt habe, um Benutzern mit unterschiedlichem Computererlebnis und wenig Erfahrung mit WordPress zu helfen:
Diese werden auf der öffentlichen Website und auch in den Dashboards der Benutzer angezeigt, sodass sie während der Arbeit mit dem Framework problemlos darauf zugreifen können. Wenn Sie Dokumentation, Lernprogramme oder Videos für Ihr Framework erstellen, fügen Sie dem Dashboard möglicherweise einen Bildschirm mit Details zu Ihren Dokumenten hinzu.
Das Erstellen von Tutorials oder Videos ist jedoch sehr zeitaufwändig und erfordert viel Arbeit, um richtig zu werden: schlecht geschriebene Tutorials oder schlecht produzierte Videos werden sich schlecht auf Ihr Framework auswirken und können Ihnen mehr schaden als eine einfachere Form der Dokumentation.
Wer auch immer Ihr Theme-Framework verwenden wird, eine Art Dokumentation ist unerlässlich. Unabhängig davon, ob Sie das Framework nur für Sie und Ihr Team entwickeln oder zur weiteren Verwendung freigeben, müssen Sie Informationen zur Dateistruktur und zur API aufzeichnen.
Die Optionen, die ich oben besprochen habe, reichen von einfachen Kommentaren bis zu komplexeren Videos, wobei alles dazwischen liegt. Was Sie sich entscheiden, hängt von den Bedürfnissen Ihrer Benutzer ab und kann sich im Laufe der Zeit ändern, wenn Sie eine größere Benutzerbasis gewinnen.
