Skip to content

Latest commit

 

History

History

docs

CrInGE - Dokumentation

Ablageort

Dieser Ordner stellt die oberste Ebene der docs dar. Hier sollen ausschließlich die Markdown Dokumentationsdateien liegen.

Alle für die Dokumentation benötigten Ressourcen, wie UML Diagramme oder UI Mockups, bekommen einen eigenen Ordner innerhalb des resources Ordners.

Geforderte Dateien

Für alle Diagramme soll sowohl der aktuelle Stand sowohl als png als auch das Orginaldokument des Ertellungstools vorhanden sein.

Benennung

Die Benennung dieser Dateien folgt dabei dem festen Prinzip:

  • Der Dateiname soll äquivalent zu dem Anwedungsfall namen sein
  • Bei Leerzeichen soll ein Unterstrich eingefügt werden.

Author

Tim Schnur