Glossar und Definitionen
Alle im System verwendeten Abkürzungen und Definitionen sind hier hinterlegt. Die einzelnen Dokumente referenzieren auf dieses Dokument und definieren daher keinen Glossar oder Definitionen.
Glossar
Die folgende Tabelle beinhaltet alle Abkürzungen, die in diesem Projekt verwendet werden.
Abkürzung | Beschreibung |
---|---|
(FK) | Foreign Key. Ein Schlüssel der in einer anderen Tabelle als Schlüssel verwendet wird. |
CDDB | CD Database. Eine frei zugängliche Datenbank die Daten zu den meisten käuflich zu erwerbenden CDs beinhaltet. |
Deployment | Unter diesem Begriff werden alle Arbeiten die mit der Installation und Konfiguration eines Systems zu tun haben beschrieben. | Patch | Ein Patch ist meist ein kleines Stück Software, dass ein bestimmtes Fehlverhalten eines Systems korrigieren soll. Im Fall eines Patches soll nicht das gesamte System, wie bei einem Releasewechsel, neu installiert werden sondern nur ein kleiner Teilbereich. | Release | Bei einem Release handelt es sich um eine neue Version eines Softwaresystems. Ein Release beinhaltet normalerweise mehr Funktionalität als der Vorgänger oder die vorhandene Funktionalität wurde stabilisiert und korrigiert. Bei einem Release werden alle vorher eingespielten Patches integriert und das System in einen stabilen Zustand gefahren. |
VirtL | Virtual Library. Dieses System hilft die Medien (CDs, DVDs, Magazine, Bücher usw.) webbassiert zu verwalten. |
Natel | Natel ist der schweizer Begriff für den deutschen Begriff Handy. Um die Verwirrung komplett zu machen nennen unsere englischen Freunde dieses Ding Mobilephone und die US-Amerikaner es Cellphone. Wenn du jetzt noch nicht weist von was wir reden kannst du das Ding auch mobiles Telefon nennen. |
7*24 Stunden Betrieb | Beim 7*24h Stunden Betrieb wird ein System, wie in unserem Fall der Webauftritt und VirtL selbst, sieben Tage die Woche 24 Stunden betrieben. Das bedeutet, dass im Normalfall das System nicht heruntergefahren wird und ständig verfügbar ist. In der Realistät werden jedoch Wartungsarbeiten und Systemausfälle erwartet. VirtL wird daher, je nach Servicevertrag mit dem Provider, eher ca. 98% verfügbar sein. Das bedeutet, dass pro 100h Laufzeit Zwei Stunden mit Unterbruch zu rechnen ist. Oder wenn man die Ausfallzeit auf ein Jahr hochrechnet kommt man bei 98% Verfügbarkeit auf einen Dauerausfall von einer Woche pro Jahr. |
Rollendefinitionen
In der folgenden Tabelle werden alle Rollendefinitionen, die in diesem Projekt Anwendung finden, beschrieben. In der Dokumentation wird eine Rolle grundsätzlich kursiv dargestellt.
Rolle | Beschreibung |
---|---|
User | Die Rolle User bezieht sich auf die Person die dieses System verwendet. Hierbei kann es sich um eine Frau oder um einen Mann handeln. Die Rolle User wird im Folgenden in der männlichen Form als der User verwendet. |
GroupUser | Die Rolle GroupUser beschreibt eine Person für die Ansichten auf Wunschlisten und andere Eigenschaften von User freigeschalten werden. Die einzelnen User können sich zu Gruppen zusammenschließen um die Bücher, Magazine, CDs und DVDs gemeinsam zu benutzen und zu verwalten. |
Vendor | Die Rolle Vendor beschreibt eine Person die für eine Firma arbeitet und die Wunschlisten der User abarbeitet und die Wünsche der User für diese zum Verkauf bereitstellt. |
System | Alle automatischen Abläufe innerhalb des Systems werden von der Rolle System gesteuert. |
Systemadministrator | Der Systemdministrator verwaltet das gesamte System und kann zum Beispiel neue User im System registrieren. |
Administrator | Der Administrator ist in der Lage eine UserGroup zu verwalten. Diese Rolle wird von einem User wahrgenommen. |
Asshole | Ein Asshole (Arschloch) ist ein Individium, das versucht das System zu sabotieren. Ein Asshole kann das System versuchen zu stören, Daten von Anwendern zu stehlen oder das System für kriminelle Zwecke zu verwenden. Diese Personengruppe muß (leider) vom System ferngehalten werden. Falls es möglich ist, sollen diese Personen ausfindig gemacht und bloßgestellt werden. Diese Rolle wurde bewußt mit einem negativ vorbelegten Wort belegt, da diese Personengruppe nur unnötig Arbeit macht um sich zu provilieren. |
Begriffsdefinitionen
Die verwendeten Begriffe, die unterschiedlich aufgefasst werden können, oder im Zweifelsfall zu Verwirrung und Fehlern führen, sind hier beschrieben.
Funktionale Anforderungen
Diese Art von Anforderungen werden dazu verwendet um zu beschreiben was ein System funktionell leisten soll. Eine Funktion ist dabei die Eigenschaft was getan wird. Zum Beispiel kann mit diesem System eine Email generiert werden, wenn eine Reservation von einem Buch möglich ist.
Funktionale Anforderungen beschreiben nicht, wie schnell ein System seine Aufgaben wahrnimmt. Im Prinzip ist es egal, ob für das Einfügen eines Authors zum Buch eine Sekunde oder eine Stunde vergeht. Hierbei handelt es sich um nichtfunktionale Anforderungen. Wenn der Autor an ein Buch angehängt werden kann, ist die Funktion gewährleistet.
Nichtfunktionale Anforderungen
Hier geht es um Anforderungen die ein System stabil und sicher machen. Nichtfunktionale Anforderungen sind:
- Bedienbarkeit
Muss man dreizehn Buttons drücken um ein Buch einzufügen? - Sicherheit
Können nicht befugte Personen auf meine Bücherliste zugreifen? - Performance
Kann innerhalb von zwei Sekunden mit einer Rückmeldung des Systems gerechnet werden?
Anwendungsfall
Ein Anwendungsfall beschreibt eine Eigenschaft eines Systems. Mit dieser Art von Beschreibung kann eine durchgängige, saubere Beschreibung erstellt werden die für viele Aspekte verwendet werden kann.
Die Dokumentation besteht bei VirtL normalerweise aus einer HTML Seite mit folgendem Aufbau:
- Anwendungsfall Name
Besteht aus Substantiv und Verb. Beispiel: Buch anlegen. Dieser Name muss im System eindeutig sein und genau zum Ausdruck bringen um was es sich bei diesem Anwendungsfall handelt. Der Zweck des Anwendungsfalls wird in wenigen Zeilen kurz erläutert. - Vorbedingungen
Angabe welchen Zustand das System einnehmen muss bevor dieser Anwendungsfall durchgeführt werden kann. Beispiel: Der User muss angemeldet sein bevor er ein Buch anlegen kann. - Hauptszenario
Beschreibung wie der Ablauf der Verarbeitung sein soll. Beispiel: Der User gibt zuerst die ISBN Nummer ein und lässt dann das System die Stammdaten zu diesem Buch suchen. - Alternativszenario
Falls es ein oder mehrere weitere Szenarios gibt werden diese vermerkt.
Beispiel: Der User erfasst ein antikes Buch das keine ISBN Nummer besitzt. - Endebedingung
Welchen Zustand soll das System einnehmen wenn die Verarbeitung beendet wird?
Beispiel: Das Buch wurde eingeführt. - Fehlerbedingung
Was soll geschehen wenn ein Fehler bei der Verarbeitung auftritt?
Beispiel: Das Buch wurde schon von einem anderen User eingegeben. Die Verarbeitung wird abgebrochen.
Cleanup Job
Mit der Webapplikation werden die meisten Funktionen zur Verfügung gestellt um das System zu administrieren. Es handelt sich um eine Server basierte Anwendung die dem User über einen Webbrowser zur Verfügung steht.
Die funktionalen Anforderungen an die Webapplikation sind im Kapitel funktionalen Anforderungen beschrieben. Alle nichtfunktionalen Anforderungen sind im Kapitel Nichtfunktionalen Anforderungen beschrieben.
Website Information Parser Plugins
Diese Plugins ermöglichen es dem System die Informationen zu Magazinen, Büchern, CDs und DVDs von externen Webseiten zu importieren und den jeweiligen Medien zuzuweisen.
Beispiel:
Ein User möchte für das Magazin Easy Linux die Artikelbeschreibungen automatisch in das System einlesen um nach Inhalten der Artikel später suchen zu können. Er erzeugt ein Plugin, mit dem er die Easy Linux Homepage nach Artikeln durchsuchen und die Information extrahieren kann.
Die Plugins sind für Informationsanbieter gedacht, die noch keine Webservices für den Datenaustausch anbieten.
Hilfesystem
An jeder Stelle, an der es für das jeweilige Eingabemedium sinnvoll ist, soll ein Hilfesystem aufgerufen werden können. Besonders bei der Webapplikation kann eine umfassende Hilfefunktion erstellt und angeboten werden.
Folgende Eigenschaften bietet das Hilfesystem:
- Volltextsuche
Eingabe eines Suchbegriffes und anschließende Trefferanzeige zur Auswahl. - Index
Alle Themenbereiche werden in einem Index dargestellt. - FAQ
Frequently Asked Questions sind über das Hilfesystem zu erreichen. - Fragen – Antworten Bei diesem Teilgebiet werden dem User eine Liste von Fragen aufgelistet. Wenn der User eine Frage auswählt, wird ihm zu diesem Thema eine oder mehrere Antworten geliefert.
SMS Dienst
Der User kann sich seine Wunschliste und Informationen zu seinen Medien per SMS auf sein Mobiltelefon senden lassen.
Systemadministrationsdienstet
Um das System jederzeit lauffähig und stabil zu halten müssen diverse Dienste angeboten werden. Mit diesen Diensten kann der Systemadministrator das System pflegen.
Selektionseinschränkungen
An einigen Stellen im System werden dem User Selektionskriterien angeboten, mit denen er in die Lage versetzt werden soll seine Suchabfragen einzuschränken. Falls die Filterkriterien beim Selektieren dazu führen, dass dem User mehr als 100 Ergebnisse zurückgeliefert wird, meldet das System dies dem User, damit dieser die Filterkriterien stärker einschränken kann. Es soll immer nur eine vernünftige Anzahl von Ergebnissen zurückgeliefert werden.
Passwort Eigenschaften
Die Passwörter, und deren Verwaltung, müssen einigen Eigenschaften genügen um das System sicher zu gestalten.
Passwort Alter
Ein Passwort soll alle sechs Wochen geändert werden. Damit ist sichergestellt, dass ein von einem Asshole geknacktes Passwort nicht unendlich lang für seine dunklen Bedürfnisse verwenden können.
Passwortwechsel
Die letzten drei verwendeten Passwörter dürfen nicht mehr verwendet werden. Ein Passwort muss mindestens einen Tag im Einsatz gewesen sein. Mit dieser Maßnahme soll verhindert werden das ein User sein Passwort innerhalb von wenigen Minuten mehrmals ändert um sein altes Passwort wieder verwenden zu können.
Passwort Zusammensetzung
Ein Passwort soll mindestens acht Zeichen lang sein.
Weiterhin soll das Passwort aus Sonderzeichen, Zahlen, Buchstaben in Groß und Kleinschreibung bestehen. Wenn der User ein nicht sicheres Passwort verwenden will, muss er auf die Sicherheitslücke hingewiesen werden.
Ein Passwort sollte nicht auf die Person zurückzuführen sein. Das Geburtsdatum und die Initialen sind keine sinnvollen Passwörter.