Dieter Petereit 13. Oktober 2017

(Nicht nur) WordPress: Schöne Dokumentationen mit WPThemeDoc

WPThemeDoc von Rich Tabor ist eine HTML-Vorlage, mit deren Hilfe du ganz einfach und gleichzeitig zeitgemäß eine Dokumentation für dein WordPress-Theme schreiben kannst; oder für jedes andere Projekt.

Simpel, elegant und schnell zum Ergebnis

Rich Tabors HTML-Template WPThemeDoc ist die Grundlage für alle Dokumentationen seines Theme-Providers ThemeBeans. Dankenswerterweise entschloss sich Rich, sein Template unter der GPL-Lizenz komplett kostenlos der Allgemeinheit zugänglich zu machen.

So sieht eine Dokumentation mit WPThemeDoc aus.

Aufgrund der Tatsache, dass es sich um eine HTML-Vorlage handelt, kannst du damit natürlich auch Seiten realisieren, die nichts mit der Dokumentation eines WordPress-Themes zu tun haben. Die Vorlage macht sich gut für Dokumentationen jeder Sorte. Dokumentierst du zum Beispiel deine Kundenprojekte? Dann wäre WPThemeDoc sicherlich ebenfalls der Überlegung wert.

Gängige Variablen beschleunigen die WP-Dokumentation

Die besondere Eignung für WordPresser ergibt sich daraus, dass Rich im HTML bereits etliche Variablen vorgesehen hat, die du durch simples Suchen und Ersetzen mit deinen eigenen Inhalten füllen kannst. Weitere Themen anzufügen oder zu entfernen, ist sehr einfach. Rich hat hier mit sprechenden IDs gearbeitet. Wer sich schon mal ansatzweise mit HTML auseinandergesetzt hat, wird keine Schwierigkeiten haben.

WPThemeDoc ist als Open Source völlig frei zu verwenden

WPThemeDoc steht auf Github zur freien Verwendung zur Verfügung. Ein Beispiel des Templates im Einsatz siehst du hier. Machs dir leicht, nimm beim nächsten Mal WPThemeDoc. Dein Handgeklöppeltes zahlt der Kunde doch eh wieder nicht.

WPThemeDoc wird auch vom Evolution WordPress Framework für die User-Dokumentation eingesetzt.

Dieter Petereit

Dieter Petereit

ist seit 1994 im Netz unterwegs, aber bereits seit über 30 Jahren in der IT daheim. Seit Anfang des neuen Jahrtausends schreibt er für diverse Medien, hauptsächlich zu den Themenfeldern Technik und Design. Man findet ihn auch auf Twitter und Google+.
Dr. Webs exklusiver Newsletter
Hinweise zum Datenschutz, also dem Einsatz von Double-Opt-In, der Protokollierung der Anmeldung, der Erfolgsmessung, dem Einsatz von MailChimp als Versanddienstleister und deinen Widerrufsrechten findest du in unseren Datenschutzhinweisen.

2 Kommentare

  1. WPThemeDoc benutze ich schon seit Jahren und kann ich nur weiterempfehlen. Auch besonders, da es kostenlos zur Verfügung gestellt wird. Damit lässt sich WP wirklich schnell dokumentieren. Viele Grüße Sophia

  2. Eine sehr schöne Anregung, vielen Dank.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

Kennst du schon unseren Newsletter?

Hinweise zum Datenschutz, also dem Einsatz von Double-Opt-In, der Protokollierung der Anmeldung, der Erfolgsmessung, dem Einsatz von MailChimp als Versanddienstleister und deinen Widerrufsrechten findest du in unseren Datenschutzhinweisen.

Cookies

Weitere Informationen zu den Auswahlmöglichkeiten findest du hier. Dazu musst du zunächst keine Auswahl treffen!

Um Dr. Web zu besuchen, musst du eine Auswahl treffen.

Deine Auswahl wurde gespeichert!

Informationen zu den Auswahlmöglichkeiten

Was du erlaubst!

Um fortfahren zu können, musst du eine Auswahl treffen. Nachfolgend erhältst du eine Erläuterung der verschiedenen Optionen und ihrer Bedeutung.

  • Ich stimme zu:
    Du erlaubst uns das Setzen aller Cookies, die wir in unseren Datenschutzhinweisen genannt haben. Dazu gehören Tracking- und Statistik-Cookies. Aus dem Tracking per Google Analytics bieten wir auf der Seite Datenschutz ein Opt-Out, also die Möglichkeit der Abmeldung, an.
  • Ich stimme nicht zu:
    Wir verzichten bei dieser Option auf den Einsatz von Google Analytics. Die für den Betrieb von Dr. Web notwendigen Cookies werden aber dennoch gesetzt. Einzelheiten entnimmst du bitte den Datenschutzhinweisen

Du kannst deine Cookie-Einstellungen jederzeit hier ändern: Datenschutz. Impressum

Zurück