Wissen HTML-Vorlagen

Editierbare Wissens-HTML-Vorlagen

Wissens-HTML-Vorlagen sind vollständige Hilfe-Center- und Dokumentations-Websites, die als editierbare Dateien bereitgestellt werden. Das Seitenset ähnelt dem jeder anderen Website, mit Startseite, Kategorieübersichten, Artikelseiten und einem Kontaktformular. Was sich ändert, ist die Art der Anpassung: Alles liegt im Quellcode, wo Entwickler Markup, Klassen und Blockreihenfolge direkt bearbeiten.

Was im Download enthalten ist

Die Pakete unterscheiden sich, doch die meisten enthalten deutlich mehr als nur eine Handvoll Seiten:

1. Artikel- und Kategoriemuster, die Sie für jeden neuen Eintrag kopieren;
2. Navigationselemente wie Breadcrumbs, eine Seitenleiste und ein Inhaltsverzeichnis;
3. Interaktive Elemente wie ein Suchfeld, ein Akkordeon-FAQ oder Reiter-Bereiche;
4. Ein Kontakt- oder Ticket-Formular, das Sie mit Ihrer eigenen Übermittlungsmethode verknüpfen können.

Zu prüfen, was davon tatsächlich vorhanden ist, ist der erste Schritt. Ein Suchfeld und ein Akkordeon hängen von Skripten ab, die der Vorlage beiliegen, und ein Paket ohne diese überlässt Ihnen die Umsetzung dieses Verhaltens.

Einen weiteren Artikel erstellen, ohne von vorn zu beginnen

Das Hinzufügen eines Eintrags zu einer bereits eingerichteten Vorlage läuft meist so ab:

1. Kopieren Sie die Datei des Artikels und tauschen Sie Überschrift, Fließtext und Links aus;
2. Fügen Sie den Eintrag in die Kategorieübersicht und in den Navigationsbaum ein;
3. Prüfen Sie, ob Breadcrumbs und weiterführende Links dorthin verweisen, wo sie sollen.

Dieser Ablauf bleibt nur so lange kurz, wie das Muster beibehalten wird. Wenn jede Anleitung ihre Überschrift, ihre Schritte und ihre weiterführenden Links in derselben Reihenfolge behält, öffnet ein Redakteur eine Datei und weiß sofort, wo er suchen muss. Überschriftenebenen, die dem Material folgen, Listen für Abläufe und Links für weiterführende Einträge sollten in der Demo genau geprüft werden, da diese Anordnung auf jede kopierte Seite übertragen wird.

Schmale Bildschirme und dichtes Referenzmaterial

Referenzartikel enthalten lange Absätze, verlinkte Begriffe und Screenshots. Tabellen und Code-Beispiele sind der heikle Teil, da sie sich nicht ohne Weiteres verkleinern lassen und meist einen eigenen Scrollbereich benötigen.

Nicepage Responsive Modi decken den Bereich vom großen Desktop bis zum Smartphone im Hochformat ab. Öffnen Sie eine Artikelseite mit ihrer Seitenleiste und der Suchfunktion in diesen Ansichten, da diese Elemente zuerst geladen werden.

Prüfen Sie vor Ihrer Entscheidung drei Dinge in der Demo: das enthaltene Seitenset, den Aufbau des Quellcodes nach dem Öffnen einer Datei und das Verhalten eines Artikels auf einem Smartphone. Ein Paket, das alle drei Kriterien erfüllt, erlaubt es Ihnen, Dokumentation zu schreiben, statt das Grundgerüst drumherum neu aufzubauen.