Skip to content

Mini Docu / Introduction / Help

Als Anwender ist der Einstieg in die neue moderne Webapplikation etwas schwierig. Aus diesem Grund sollte es eine Hilfe direkt im Programm geben, womit erklärt wird, welche Tabs es gibt und wie man die Software bedient (Steuerung).

Akzeptanzkriterien:

  • in "Help" > "Introduction / Help" öffnet ein Link
    • führt zum Wiki des Repos
  • Wiki besitzt einen neuen Ordner
    • Name "howto"
    • Ordner besitzt verschiedene Markdown-Dateien
      • README.md beinhaltet kurze Beschreibung über die Anwendung (kann aus README (#56 - closed) entnommen werden, wenn umgesetzt ist)
      • Layout.md beinhaltet Informationen darüber, dass das Layout angepasst werden kann (Stichwort Tab, Stichwort freibeweglich)
        • am besten mit Gifs (kann der Lui erstellen)
        • es wird erwähnt, dass das Layout gespeichert wird
      • Export.md
        • beinhaltet Beschreibung glTF
        • beinhaltet Beschreibung View
      • Settings.md
        • dass das Model bearbeitet werden kann
      • Tabs.md
        • jeder Tab wird beschrieben
      • XMLParameters.md
        • beinhaltet Beschreibung von XML-Pflichtparametern und deren Werten
        • beinhaltet Beschreibung davon, dass XML-Parameter "lokal" in der config überschrieben werden können
    • Wikiseiten besitzen Chapters-Übersicht
  • ein Benutzer, der die Anwendung zum ersten Mal startet, sieht die Hilfe im Docking Panel
    • "localStorage" beinhaltet "firstVisit"
Edited by NorthernSeaCharting