Legende: 1 = Landing Page (Kapiteldokument in FM), 2 = Landing-Page-Name (Titelfragment in FM), 3 = Kategorie (Titelfragment in FM), 4 = Kategorieseite (Kapiteldokument in FM), 5 = Untergeordnete Kategorie (Titelfragment in FM), 6 = Beschreibung (BTX_Topic in FM)
In der Onlinehilfe besteht eine App-Dokumentation aus einer Startseite – der Landing Page – und einer beliebigen Anzahl an Kategorieseiten. Eine Kategorieseite enthält eine Kategorie, evtl. zusätzliche untergeordnete Kategorien sowie Artikel mit Beschreibungen oder Handlungsanweisungen zu unterschiedlichen Use Cases.
Eine Kategorieseite in der Onlinehilfe entspricht einem in FrameMaker (FM) erstellten Kapiteldokument. Ein Artikel entspricht einem Topic. Eine Kategorie und zusätzliche untergeordnete Kategorien werden in FrameMaker je als Titelfragment erstellt. Titelfragmente und Topics sind also in beliebiger Anzahl in einem Kapiteldokument enthalten. Kapiteldokumente sind wiederum in beliebiger Anzahl in einem Publikationsbuch enthalten.
Für die Landing Page gibt es ebenfalls ein Publikationsbuch. Darin ist ein Kapiteldokument mit meist nur einem Titelfragment und mehreren Topics enthalten.
Pro App-Dokumentation gibt es also 2 Publikationsbücher. Eines für die Landing Page und eines für alle Kategorieseiten zusammen.
Information: Titelfragmente werden in FrameMaker mit der Abkürzung TIT, Handlungsanweisungen mit HAW und Beschreibungen mit BTX abgespeichert. |
Weitere Informationen:
Startseite