Dokumentieren von Apps

Ordnerstruktur für neue App-Dokumentation anlegen

Ordnerstruktur für neue App-Dokumentation anlegen

Ordner für Ablage der Topics anlegen

  1. Den Ordner DokuModular auf dem Laufwerk K:\ öffnen.

  2. Den Ordner mit der entsprechenden Sprache der dokumentierten App öffnen.

  3. Den Ordner 01_Topics öffnen.

  4. Einen neuen Ordner für die App anlegen und mit der Nummerierungskonvention benennen: 01_xx_Appname.

    Hier werden alle Topics für die App abgelegt.
  5. Im neuen Ordner drei Unterordner anlegen:

    • Administration: Hier werden das Topic-Adminbuch und die Excel abgespeichert.
    • Outdated: Hier werden Topics abgespeichert, die inhaltlich veraltet sind, d.h. eine ältere Version haben.
    • Screenshots: Hier werden alle Screenshots für die App abgespeichert.

Ordner für Publikation einer neuen App-Dokumentation anlegen

  1. Den Ordner DokuModular auf dem Laufwerk K:\ öffnen.

  2. Den Ordner mit der entsprechenden Sprache der dokumentierten App öffnen.

  3. Den Ordner 02_Publikation öffnen.

  4. Einen neuen Ordner für die App anlegen und mit der Nummerierungskonvention benennen: 02_xx_Appname.

  5. Im neuen Ordner zwei Unterordner anlegen:

    • Export Onlinehilfe: Hier die Unterordner Aktuelles Buch (für die Publikation der App in der Onlinehilfe) und Outdated (für veraltete Publikationsbücher) anlegen.
    • Prüfung: Hier werden die Bücher für die PDF-Ausgabe zur Prüfung durch das Produktmanagement abgelegt.

Ordner für Ablage der PDF-Dateien zur fachlichen Prüfung

  1. Den Ordner DokuModular auf dem Laufwerk K:\ öffnen.

  2. Den Ordner mit der entsprechenden Sprache der dokumentierten App öffnen.

  3. Den Ordner 03_Deliveries öffnen.

  4. Einen neuen Ordner für die App anlegen und mit der Nummerierungskonvention benennen: 03_xx_Appname.

  5. In diesem Ordner für jedes PDF einen Unterordner mit Datum anlegen.

Hinweis: Die Ordnerstruktur für alle Apps muss in den verschiedenen Sprachen identisch sein.