Dokumentieren von Apps

Dokumentieren von neuen Apps

Dokumentieren von neuen Apps

Wenn eine neue App-Dokumentation benötigt bzw. beauftragt wird, werden zunächst die Informationsquellen und Ansprechpartner recherchiert sowie die Informationen gesammelt, mit denen die App-Dokumentation befüllt werden soll.

Im Anschluss daran kann ein Konzept erstellt werden. D.h. die gesammelten Informationen werden sortiert und gruppiert, um eine Idee für mögliche Kategorien und Topics zu erhalten. Um die Struktur der App-Dokumentation mit Kategorien, Unterkategorien und möglichen Topics abzubilden und diese später leichter verwalten zu können, wird außerdem eine Admin-Excel erstellt.

> Excel für Topic-Administration erstellen

Die Admin-Excel jeder App-Dokumentation liegt an einer bestimmten Stelle auf dem Laufwerk. Daher ist es nötig, für jede neue App-Dokumentation auch eine festgelegte Ordnerstruktur anzulegen. Darin werden neben der Admin-Excel z.B. auch Topics, Screenshots und das Publikationsbuch abgelegt.

> Ordnerstruktur für neue App-Dokumentation anlegen

Danach werden mit den gesammelten Informationen die Topics und Titelfragmente in FrameMaker erstellt. Verwaltet werden die Topics zusätzlich zur Admin-Excel noch im Adminbuch.

> Topic-Adminbücher erstellen