Planen einer WordPress-Wissensdatenbank

Vor vielen Jahren habe ich technische Handbücher für Kunden geschrieben. In der Regel handelt es sich dabei um Papierdokumente mit hunderten von Seiten technischer Informationen, die von den meisten Leuten, für die sie hergestellt wurden, als praktischer Platz für die Kaffeetasse verwendet werden. Wenn der Client außergewöhnlich fortgeschritten war, gab es möglicherweise eine PDF-Version, die jedoch selten verwendet wurde.

Die Zeiten haben sich weiterentwickelt und die meisten Handbücher oder Wissensbasen, wie sie oft genannt werden, liegen in digitaler Form vor. Sie können die Form einer App oder Website oder eine Art Simulation haben, haben jedoch immer Daten im Kern. Die Wissensdatenbanken müssen für Benutzer leicht zu suchen und zu navigieren sein, und sie müssen für Autoren leicht in der Lage sein, Inhalte zu hinzufügen oder Inhalte zu bearbeiten, ohne dass mehr als einmal Daten bearbeitet werden müssen.

Deshalb ist jedes System, das von einer Datenbank gesteuert wird, am besten geeignet. Ich nutze WordPress bereits seit einiger Zeit, um diese Art von interner Website voranzutreiben, und ich finde die Flexibilität, die WordPress Ihnen beim Anzeigen und Abfragen von Daten bietet, kombiniert mit der Admin-Benutzeroberfläche, die vielen bekannt ist, ideal Werkzeug.

In dieser Serie zeige ich Ihnen, wie Sie mit WordPress eine Wissensdatenbank aufbauen. Ich werde Sie durch die folgenden Schritte führen:

  1. Planen Sie Ihre Wissensdatenbank, insbesondere planen Sie, wie Ihre Inhalte zu den Inhaltstypen von WordPress passen. Bestimmen, wie die Struktur der Site aussehen muss und welche benutzerdefinierten Vorlagendateien Sie ggf. erstellen müssen.
  2. Strukturierung Ihrer Wissensbasis Erstellen Sie die entsprechenden Vorlagendateien und schreiben Sie benutzerdefinierte Abfragen.
  3. Erstellen Sie das Front-End Ihrer Wissensdatenbank. Erstellen Sie die Vorlagendateien, gestalten Sie sie und fügen Sie zusätzliche Navigation, Suche und Hilfe hinzu.
  4. Machen Sie Ihre Wissensbasis zum Leben. Sehen Sie sich die Einschränkungen an, mit denen Sie möglicherweise konfrontiert sind, wie Sie den Zugriff auf die Site ermöglichen und wie sie verwaltet und verwaltet wird.

Der erste Teil davon ist die Planung, auf die ich hier eingehen werde. In dieser Serie werde ich an einer imaginären Wissensbasis arbeiten und jeden Code bereitstellen, damit Sie ihn selbst verwenden können.

Identifizieren des Inhalts Ihrer Knowledge Base

Der erste Schritt besteht darin zu ermitteln, welche Arten von Inhalten Ihre Wissensdatenbank enthalten wird. Meine Wissensdatenbank wird eine Quelle für WordPress-Benutzer und -Entwickler sein.

Es enthält die folgenden Arten von Inhalten:

  • FAQs
  • Schnelle Tipps
  • Tutorials
  • Schnipsel
  • Links
  • Videos

Dieser Inhalt wird dann nach der Zielgruppe und den übergeordneten Themen sortiert. Für eine detailliertere Sortierung werden auch Tags verwendet.

Mein Publikum ist in zwei Gruppen aufgeteilt:

  • Benutzer
  • Entwickler

Für Entwickler sind die übergeordneten Themen:

  • Themenentwicklung
  • Plugin-Entwicklung
  • Funktionen
  • Aktions- und Filterhaken
  • Abfragen und die Datenbank

Für Benutzer sind die übergeordneten Themen:

  • Das Dashboard
  • Inhalt hinzufügen und bearbeiten
  • Die Medienbibliothek
  • Themes installieren, anpassen und aktivieren
  • Plugins installieren, anpassen und aktivieren
  • die Einstellungen
  • Site Management

Wie bereits erwähnt, verwendet die Site auch Tags, die von den Mitwirkenden hinzugefügt werden. Diese sind nicht spezifisch für Benutzer oder Entwickler.

Die Website wird von einem imaginären Team von WordPress-Experten verwaltet, die sich alle mit anderen Aufgaben befassen und daher in der Lage sein müssen, Inhalte schnell hinzuzufügen. Einige von ihnen verwenden die mobile App WordPress, um Inhalte hinzuzufügen.

Nachdem ich herausgefunden habe, was mein Inhalt sein muss, muss ich ihn den WordPress-Inhaltstypen zuordnen.

Passen Sie Ihre Anforderungen an WordPress an

Wie bei so vielen Aspekten der Entwicklung mit WordPress, gibt es nicht notwendigerweise nur eine Möglichkeit, Ihren Inhalt an die Organisation von WordPress anzupassen. Um das für Sie am besten geeignete zu ermitteln, müssen Sie zunächst wissen, wie WordPress Inhalte organisiert.

WordPress-Inhaltstypen

WordPress verfügt standardmäßig über drei Inhaltstypen:

  • Beiträge
  • Seiten
  • Anlagen

Beachten Sie, dass es in WordPress noch andere Inhaltstypen gibt, z. B. Links, Kommentare und Navigationsmenüelemente. Die drei oben genannten sind jedoch am wichtigsten.

Sie können auch Ihre eigenen Inhaltstypen hinzufügen und so viele wie erforderlich erstellen, indem Sie benutzerdefinierte Beitragstypen verwenden. Diese können sich wie Posts oder Seiten verhalten. Der Hauptunterschied besteht darin, dass Seiten hierarchisch sind und Posts nicht. In diesem Fall ist die Hierarchie für meine Hauptinhaltstypen kein Problem.

WordPress-Taxonomien

WordPress verfügt über zwei integrierte Taxonomien, die Sie für Ihre Beiträge, Seiten und benutzerdefinierten Beitragstypen verwenden können:

  • Kategorie 
  • Etikett

Darüber hinaus können Sie zusätzliche Taxonomien registrieren, um Ihre Daten besser sortieren und abfragen zu können.

Identifizieren, was Sie brauchen

Wenn Ihre Wissensdatenbank über mehrere Inhaltstypen verfügt, können Sie dies auf drei Arten tun:

  • Verwenden Sie einen Inhaltstyp (z. B. Beiträge) und verwenden Sie Kategorien, um den jeweiligen Inhaltstyp zu ermitteln.
  • Verwenden Sie einen Inhaltstyp (z. B. Beiträge) und verwenden Sie eine benutzerdefinierte Taxonomie, um den Inhaltstyp zu identifizieren.
  • Registrieren Sie einen Beitragstyp für jeden Ihrer Inhaltstypen.

Die erste Option ist für Anfänger die einfachste, da Sie keinen benutzerdefinierten Code schreiben müssen und mit WordPress arbeiten können. Die zweite Option bietet Ihnen mehr Flexibilität und ist ein effizienter Ansatz, wenn Sie alle Inhaltstypen zusammen auflisten möchten, anstatt sie immer aufzuteilen. Es ist auch nützlich, wenn ein Inhalt mehr als einen Inhaltstyp enthält. Die dritte Option bietet Ihnen die größte Flexibilität, solange Ihre Inhaltstypen immer getrennt sind.

Im Falle meiner Wissensdatenbank kann es sein, dass einige meiner Inhalte aus mehr als einem Inhaltstyp bestehen (zum Beispiel kann ein kurzer Tipp die Form eines Videos haben oder einen Link enthalten), sodass ich keine separaten Beitragstypen registrieren werde . Stattdessen werde ich eine benutzerdefinierte Taxonomie für meine Inhaltstypen erstellen.

Neben den Inhaltstypen muss ich auch darüber nachdenken, wie meine Daten kategorisiert werden. Jeder Beitrag wird sich in einem oder mehreren Themen mit einer oder mehreren Zielgruppen befinden. Da die Themen eindeutig auf die beiden Zielgruppen abgestimmt sind, werde ich zwei Taxonomien registrieren: eine für Benutzerthemen und eine für Entwicklerthemen. Das heißt, ich kann die Themen für jedes Publikum auf den relevanten Seiten der Site auflisten.

Dies bedeutet, dass meine Wissensdatenbank Folgendes verwendet:

  • Beiträge
  • Seiten
  • Stichworte
  • Drei benutzerdefinierte Taxonomien: Benutzerthema, Entwicklerthema und Inhaltstyp

Ich muss also diese drei Taxonomien registrieren, aber keine Posttypen. Da ich keine integrierten Kategorien verwende, werde ich diese auch deaktivieren, damit meine Autoren nicht versehentlich Kategorien zuweisen.

Planen der Struktur Ihrer Wissensdatenbank

Nun, da ich weiß, welchen Inhalt meine Wissensdatenbank enthalten wird und wie die Daten gespeichert werden, muss ich über die Struktur der Seiten meiner Wissensdatenbank nachdenken. Die Site verwendet eine Kombination aus Archiven und statischen Seiten mit einer Startseite mit den neuesten Beiträgen zu allen Themen.

Ich muss auch über meine Navigation nachdenken - sowie über die Navigation im Menü. Ich werde die Themennavigation in die Seitenleiste und auch ein Suchfeld aufnehmen.

Seitenstruktur

Meine Website wird also Folgendes enthalten:

  • eine Homepage mit den neuesten Beiträgen zu allen Themen
  • eine statische Seite für jede der beiden Benutzergruppen und für Inhaltstypen
  • eine Archivseite für jeden Inhaltstyp
  • eine Archivseite für jeden Taxonomiebegriff
  • Einzelseiten für jeden Beitrag

Seitenleiste und Fußzeile

Ich füge auf allen Seiten meiner Site eine Seitenleiste und eine Fußzeile hinzu, aber ich werde sie ein wenig variieren, je nachdem in welchem ​​Bereich der Site sich der Benutzer befindet.

Folgendes wird in der Seitenleiste angezeigt:

  • Auf allen Seiten wird oben ein Suchfeld angezeigt.
  • Auf der Startseite, auf der Suchseite und auf den 404-Seiten befinden sich Links zu jeder Benutzer- und Entwicklerseite, darunter eine Liste relevanter Taxonomiebegriffe mit Links und eine Liste von Inhaltstypen mit Links zu ihren Archivseiten.
  • Auf der Benutzerseite und auf den Archivseiten für das Benutzerthema Taxonomie befinden sich Links zu den Archiven der Benutzerthemen Taxonomie.
  • Auf der Entwicklerseite und auf den Archivseiten für das Entwicklerthema Taxonomie gibt es Links zu den Entwicklerthemen Taxonomiebegriff-Archiven.
  • Auf der Inhaltstypenseite und den Archivseiten für die Inhaltstyp-Taxonomie wird eine Liste von Inhaltstypen mit Links zu ihren Archivseiten angezeigt.
  • Auf einer einzigen Seite finden Sie Links zu den Archiven für das Benutzerthema und die Entwickler-Taxonomien.

Das hört sich alles etwas kompliziert an, aber es wird sinnvoll, wenn wir mit dem Aufbau beginnen. Ich werde jedes dieser Elemente mit einer Funktion erstellen und dann mithilfe von bedingten Tags die Funktionen an einen Aktions-Hook anhängen, den ich zur Seitenleistenvorlage hinzufüge. Ich werde der Sidebar auch einen Widgetbereich hinzufügen, nur für den Fall.

Die Fußzeile enthält Listen der Taxonomie-Begriffe für alle drei meiner Themen sowie eine Liste der letzten Beiträge.

Vorlagendateien

Das heißt, ich brauche die folgenden Vorlagendateien:

  • index.php
  • page.php
  • Archiv.php
  • single.php
  • sidebar.php

Haken und Funktionen

Ich füge einen Aktionshaken hinzu, der mir hilft, die Seitenleisten zu füllen: a tutsplus_sidebar Aktion einhaken sidebar.php.

Ich werde eine an diesen Hook angehängte Funktion erstellen, die die folgenden Listen enthält:

  • Links zu den Archivseiten für die Benutzerthema Taxonomie
  • Links zu den Archivseiten für die Taxonomiebegriffe des Entwicklers
  • Links zu den Archiven für die Taxonomiebegriffe des Inhaltstyps.

Jedes dieser Elemente enthält bedingte Tags, sodass sie der Seitenleiste auf den rechten Seiten hinzugefügt werden.

Zusammenfassung

Ich habe jetzt einen Plan für den Inhalt und die Struktur meiner Wissensdatenbank, und ich habe den WordPress-Funktionen angepasst. Ich habe also genau festgelegt, was ich in WordPress erstellen muss, damit diese Wissensdatenbank funktioniert.

Es ist zwar verlockend, einzutauchen und mit dem Programmieren zu beginnen, es ist jedoch eine gute Idee, einige Zeit damit zu verbringen, Ihre Wissensdatenbank auf diese Weise zu planen, damit Sie genau wissen, welche Vorlagendateien und Funktionen Sie benötigen. Auf diese Weise wird der Code viel schneller, wenn Sie den Code schreiben.

Im nächsten Teil dieser Serie werde ich Ihnen zeigen, wie Sie Post-Typen und Taxonomien für die Daten Ihrer Wissensdatenbank registrieren und alle nicht benötigten Daten entfernen.