Dokumentieren von Apps

Checkliste für alle nötigen FM-Dokumente einer App-Dokumentation

Checkliste für alle nötigen FM-Dokumente einer App-Dokumentation

Im Folgenden wird aufgelistet, welche FM-Dokumente (FrameMaker-Dokumente) jeweils genau für eine Kategorieseite und eine Landing Page benötigt werden.

FM-Dokumente für eine Kategorieseite

Pro Kategorieseite werden folgende Topics benötigt:

  • Titelfragmente für die Kategorie und ggf. untergeordnete Kategorien

  • Topics mit Handlungsanweisungen oder Beschreibungen zu allen Use Cases der Kategorie

Diese Topics werden in ein Kapiteldokument eingefügt, welches wiederum zusammen mit weiteren Kapiteldokumenten in einem Publikationsbuch enthalten ist.

FM-Dokumente für eine Landing Page

Für eine Landing Page werden folgende Topics benötigt:

  • Titelfragment mit dem Namen der App

  • Topic mit den häufigsten Fragen zur Bedienung der App (FAQ)

  • Ggf. Topic mit dem Text „Lernen Sie die App xy kennen“, in dem das Video eingebunden wird, falls ein Video vorhanden ist.

Information: Ein Topic mit den FAQs wird nach der Erfassung aller Inhalte festgelegt. In diesem Topic werden nämlich Topics aus den Kategorieseiten verlinkt. Für die Verlinkung der Topics werden Hypertext-Marken gesetzt.

Diese Topics werden in ein Kapiteldokument eingefügt, welches wiederum in einem Publikationsbuch enthalten ist.

Weitere Informationen:

> Arbeiten mit Büchern