Dokumentation zu AlarmApp und AlarmServers

Wie in jeder Dokumentation empfiehlt es sich, das Vorwort zu lesen. Meist und so hoffentlich hier, gibt diese wichtige Informationen, wie der Text zu lesen ist. Aus der Motivation lässt sich die Struktur erklären und eine Definition der Semantik vermeidet Missverständnisse.

Motivation zur Dokumentation

Beim Schreiben der Dokumentation, haben wir uns an der Inbetriebnahme der AlarmApp orientiert. Dies spiegelt sich in ihrer Struktur wieder, die die einzelnen Schritte erklärt. Im Gegensatz zu einer einfachen Aufzählung aller möglichen Optionen und Zusammenhänge, haben wir uns von dieser Vorgehensweise den Vorteil eines einfacheren Einstiegs versprochen.

Weiterhin erschien uns eine Teilung der Dokumentation in die Perspektiven des Endanwenders und der technischen Betreuung als sinnvoll. Ein Inhaltsverzeichnis ist weiter unter gegeben.

Einige Worte zur Semantik

Das Wort AlarmApp ist leider mehrdeutig belegt, so heißt sowohl das komplette Produkt AlarmApp, als auch die tatsächliche App auf den Smartphones. Technisch gliedert sich die “AlarmApp” als Produkt jedoch in mehrere Teile auf:

  1. Den tatsächlichen Apps für iOS und Android.
  2. Einem Server, zur zentralen Ansteuerung der App und der Verwaltung der Organisationen.

Um ohne Verrenkungen eine gewisse Eindeutigkeit in der Dokumentation zu schaffen, haben wir versucht die folgende Unterscheidung möglichst konsequent umzusetzen:

Sprechen wir von der AlarmApp, so meinen wir die App auf den jeweiligen Smartphones (dort, wo eine Aussage nicht für alle Systeme gilt, ist dies hervorgehoben). Den Server dagegen bezeichnen wir als AlarmServer.