Bücher sind übergeordnete FrameMaker-Dokumente, die je nach Art des Buchs ein oder mehrere Kapiteldokumente mit allen Topics und Titelfragmenten zu einer App-Dokumentation enthalten können.
In der TR wird pro App-Dokumentation mit 3 Büchern gearbeitet:
Admin-Buch für die Topic-Administration
Buch für die fachliche Prüfung
Publikationsbuch für den Export der App-Dokumentation in die Onlinehilfe
Admin-Bücher werden hier abgespeichert: DokuModular\[Sprachkürzel]\01_Topics\[Appname]\Administration
Ein Admin-Buch enthält alle Titelfragmente sowie fast alle Topics, die es zu einer App-Dokumentation gibt. Nicht enthalten sind veraltete Topics und Kapiteldokumente. Durch die Topic-Übersicht, die ein Admin-Buch in FrameMaker bietet, hilft es bei der Administration und der operativen Arbeit mit Topics. Beispielsweise lassen sich gewünschte Topics direkt aus dem Admin-Buch heraus in FrameMaker öffnen. Außerdem kann über das Admin-Buch nach Benennungen oder Texteinheiten, Topic-IDs und ungelösten Querverweisen gesucht werden. Das ist besonders hilfreich bei Änderungen einzelner Wörter oder Fehlermeldungen im Importer. Bei Änderungen der Struktur in der EDD kann die neue Struktur in alle Topics eines Buchs importiert werden.
Bücher für die fachliche Prüfung werden hier abgespeichert: DokuModular\[Sprachkürzel]\02_Publikation\[Appname]\Prüfung
Bücher für die fachliche Prüfung enthalten nur diejenigen Topics und ggf. auch Kapiteldokumente, die dem Produktmanagement zur Prüfung weitergeleitet werden sollen. In dieser Art von Büchern wird also i. d. R. nie die ganze App-Dokumentation abgebildet.
Publikationsbücher werden hier abgespeichert: DokuModular\[Sprachkürzel]\02_Publikation\[Appname]\Export Onlinehilfe\Aktuelles Buch
Ein Publikationsbuch besteht aus Kapiteldokumenten. Jedes Kapiteldokument entspricht einer Kategorieseite in der Onlinehilfe einer App-Dokumentation:
Publikationsbücher werden für den Export einer App-Dokumentation in die Onlinehilfe verwendet. Daher bilden Publikationsbücher den aktuellen Stand der Onlinehilfe ab und werden bei Anpassungen während der Sprints aktualisiert. Wenn es also ein Publikationsbuch gibt, wird i. d. R. kein neues erstellt.
Hinweis: Bei grundlegenden Änderungen, die das Erstellen eines neuen Publikationsbuches erforderlich machen, wird im Ordner Export Onlinehilfe/Outdated ein Datumsordner mit dem aktuellen Datum nach dem Schema JJJJMMDD erstellt. Die bestehende Buchdatei sowie die zugehörigen Kapiteldokumente werden aus dem Ordner Aktuelles Buch in den neuen Datumsordner verschoben. |
Weitere Informationen:
Startseite