Dokumentieren von Apps

Exceltabelle für Topic-Administration

Exceltabelle für Topic-Administration

Für jede App-Dokumentation gibt es eine Exceltabelle mit dem Namen Topic-Administration_[Appname]. In dieser Exceltabelle werden die Struktur der App-Dokumentation sowie alle Topics, auch die der Landing Page, festgehalten. Es gibt unterschiedliche Status, die pro Topic vergeben werden, so dass man stets einen aktuellen Überblick über den Stand eines Topics hat. Daher ist es wichtig, dass die Exceltabelle immer auf dem neuesten Stand ist.

Bedeutung der einzelnen Status:

Status des Topics

Bedeutung

Noch zu schreiben

muss noch erstellt werden

Noch nicht übersetzt

muss noch übersetzt werden, wenn die Dokumentation in mehreren Sprachen vorgesehen ist

Entwurf

wurde begonnen, ist aber noch nicht fertig für die Prüfung

In Übersetzung

wird gerade übersetzt

In redaktioneller Prüfung durch [Namenskürzel]

wird gerade durch die entsprechende Person redaktionell geprüft

Redaktionell freigegeben

wurde redaktionell geprüft und für gut befunden

In fachlicher Prüfung

ist zur Prüfung beim Produktmanagement

Fachlich freigegeben

wurde durch das Produktmanagement geprüft und für gut befunden, und kann in der Onlinehilfe veröffentlicht werden

Geändert für Release

wurde für ein SP angepasst und wird nach Veröffentlichung wieder auf „Fachlich freigegeben“ gestellt

Outdated

ist veraltet und wurde aus der Onlinehilfe entfernt

Reused (andere App)

wurde für eine andere App erstellt und wird für die aktuelle App referenziert

Reused (gleiche App)

wird innerhalb einer App mehrfach referenziert

Die Exceltabelle liegt hier: DokuModular\de\01_Topics\[Appname]\Administration

Information: Im Zusammenhang mit mehrsprachig vorhandenen App-Dokumentationen ist wichtig zu wissen, dass sich anhand der Admin-Exceldatei auch die Quellsprache einer App-Dokumentation erkennen lässt. Die Quellsprache ist immer die erste Sprache in der Exceltabelle.

Weitere Informationen:

> Excel für Topic-Administration erstellen

> Status im Erstellprozess eines Topics vergeben