E2020 Wissensmanagement

Projekt

Gesamtheit der Inhalte, Einstellungen und zugehörigen Ressourcen einer Dokumentation. Ein Projekt bildet die Grundlage für die Veröffentlichung in unterschiedlichen Formaten.

Unkomprimiertes oder komprimiertes Projekt

Projektdatei

Zentrale Datei eines unkomprimierten Projekts. Sie enthält zentrale Projekteinstellungen und Verweise auf weitere Projektbestandteile. Die Inhalte der einzelnen Topics liegen in separaten Dateien. Die Projektdatei allein ist deshalb keine vollständige Sicherung des Projekts. Für eine vollständige Sicherung müssen auch die zugehörigen Dateien und verwendeten Ressourcen berücksichtigt werden.

.hmxp

Projektordner

Verzeichnis eines unkomprimierten Projekts. Es enthält die Projektdatei, Topicdateien und weitere Projektbestandteile. Zusätzlich verwendete Ressourcen können je nach Organisation auch ausserhalb dieses Ordners liegen.

Ordner mit .hmxp und zugehörigen Dateien

Komprimiertes Projekt

Speicherform, bei der die Projektbestandteile in einer einzigen komprimierten Datei zusammengefasst werden. Der Projektinhalt entspricht grundsätzlich dem unkomprimierten Format. Extern abgelegte Bilder und Snippets können weiterhin ausserhalb der Projektdatei liegen.

.hmxz

Topic

Einzelne inhaltliche Einheit, beispielsweise eine Begriffserklärung oder eine Anleitung. Ein Topic kann unabhängig von seiner Position im Inhaltsverzeichnis bearbeitet und verlinkt werden.

Beispielsweise Variablen umbenennen

Topicdatei

Datei mit dem Inhalt und den zugehörigen Angaben eines Topics. Bei unkomprimierten Projekten liegt sie als separate XML-Datei vor.

.xml

Inhaltsverzeichnis (TOC)

Hierarchische Gliederung der Dokumentation. Seine Einträge verweisen auf Topics. Die sichtbare Gliederung ist von der Ablage der Topicdateien zu unterscheiden.

Kapitel und Unterkapitel

Snippet

Wiederverwendbarer Inhalt, der in ein Topic eingefügt wird. Bei verlinkten Snippets werden Änderungen an der Quelle an den verwendenden Stellen übernommen. Eine eingefügte Kopie bleibt dagegen unabhängig von der Quelle.

Topicdatei als Inhaltsbaustein

Formatvorlage

Benannte Festlegung für die Gestaltung von Texten, Absätzen oder Tabellen. Sie ermöglicht eine einheitliche Formatierung und zentrale Anpassungen.

Beispielsweise t_product

Style-Repository

Spezielles Help+Manual-Projekt zur gemeinsamen Nutzung von Formatvorlagen und Snippets in mehreren Projekten. Es besitzt kein eigenes Inhaltsverzeichnis.

.hmxr

Variable

Benannter Platzhalter für einen Wert, beispielsweise einen Produktnamen oder eine Versionsnummer. Der Wert wird bei der Veröffentlichung eingesetzt.

Beispielsweise <%VERSION%>

HTML-Seitenvorlage

Vorlage für den Aufbau einer erzeugten HTML-Seite. Sie legt beispielsweise fest, wo Titel, Topicinhalt und weitere Seitenelemente erscheinen.

HTML-Vorlagencode im Projekt oder Skin

Skin

Zusammenstellung von Gestaltungseinstellungen für HTML-basierte Ausgaben. Ein Skin kann unter anderem Seitenvorlagen, Formatvorlagen, Variablen und zusätzliche Dateien enthalten und wird bei der Veröffentlichung ausgewählt.

.hmskin

Druckvorlage

Vorlage für die Seitengestaltung der PDF-Ausgabe. Sie definiert beispielsweise Titelseite, Kopf- und Fusszeilen, Seitenzahlen und Inhaltsverzeichnis. Die Bearbeitung erfolgt im Manual Designer.

.mnl

Baggagedateien

Zusatzdateien, die Help+Manual im Projekt verwaltet und abhängig vom Ausgabeformat mit der Ausgabe bereitstellt, beispielsweise CSS-Dateien, Skripte oder Grafiken für WebHelp.

.css, .js, Bilddateien

Veröffentlichung

Vorgang, bei dem Help+Manual aus den Projektinhalten und den gewählten Einstellungen eine Ausgabe erzeugt. Die erzeugten Dateien werden anschliessend am vorgesehenen Ablageort bereitgestellt.

Funktion Publish

Ausgabeformat

Technisches Format der veröffentlichten Dokumentation. Die Auswahl richtet sich nach dem vorgesehenen Nutzungszweck.

WebHelp, PDF, DOCX und weitere

WebHelp

HTML-basierte Dokumentation zur Nutzung im Browser. Sie besteht aus mehreren zusammengehörigen Dateien und bietet typischerweise Navigation und Suchfunktion.

HTML-, CSS-, JavaScript- und Mediendateien