qs dokument

This commit is contained in:
M.Scholz 2012-01-21 11:24:25 +01:00
parent c3c433b601
commit 008fd65478
5 changed files with 50 additions and 27 deletions

4
.gitignore vendored
View File

@ -39,3 +39,7 @@ ws2011/BP/soapUI/.DS_Store
ws2011/BP/alte BPs Unterlagen/daSense vorherige Gruppe/.DS_Store
ws2011/BP/PHP-UML/.DS_Store
literature/Galileo Computing - Java ist auch eine Insel 10 Auflage/bilder/.picasa.ini
ws2011/CE/Klausurvorbereitung/.picasa.ini

View File

@ -8,4 +8,9 @@ http://www.da-sense.de/test/api.php?flag=deviceinfo&json={"deviceType":1, "devic
JSON Format flag = input:
http://www.da-sense.de/test/api.php?flag=input&source=smartphone&json={"device":"APITEST","measurementType":1, "user":20, "series": [ { "name":"testseries3", "visibility":0, "timestamp":1 , "values": [ { "timestamp":1, "value":52.25234634, "longitude":0, "latitude":0, "altitude":0, "accuracy":0, "speed":null, "provider":"GPS", "tags": [ { "key": 1, "value":35 } ] } ] } ] }
http://www.da-sense.de/test/api.php?flag=input&source=smartphone&json={"device":"APITEST","measurementType":1, "user":20, "series": [ { "name":"testseries3", "visibility":0, "timestamp":1 , "values": [ { "timestamp":1, "value":52.25234634, "longitude":0, "latitude":0, "altitude":0, "accuracy":0, "speed":null, "provider":"GPS", "tags": [ { "key": 1, "value":35 } ] } ] } ] }
JSON Format result = ? :
http://www.da-sense.de/test/api.php?result= ….

View File

@ -128,37 +128,32 @@ Die Ma
\subsection{Benutzbarkeit}
\label{Ziel:Benutzbarkeit}
Die Benutzbarkeit unterteilen wir in die drei Qualitätsmerkmale \textit{Verständlichkeit}, \textit{Bedienbarkeit} und \textit{Attraktivität}, welche wir nach \cite{ISO/IEC 9126} definieren. Diese Punkte werden von unserem Auftraggeber im zweiten Teil des Praktikums gefordert. \\
Eine intuitive und leicht bedienbare Benutzeroberfläche steigert die Aufmerksamkeit des
Besuchers und verhilft dem Projekt zu einem höheren Bekanntheitsgrad. Ebenso kommt hierbei
eine moderne und attraktive Visualisierung der Daten zum Einsatz, die die Informations-
erfassung unterstützt. Durch das Bekanntwerden des Projekts erhofft sich unser Auftrag-
geber eine breite Verteilung der kommenden da-sense Android-App, mit der Benutzer Daten
sammeln und auf die Datenbank transferieren können. Die Daten sind über die Webapplikation
abrufbar.\\
Die Benutzbarkeit unterteilen wir in die drei Qualitätsmerkmale \textit{Verständlichkeit}, \textit{Bedienbarkeit} und \textit{Attraktivität}, welche wir nach \cite{ISO/IEC 9126} definieren. Diese Punkte werden von unserem Auftraggeber im zweiten Teil des Praktikums gefordert. \\ \\
Eine intuitive und leicht bedienbare Benutzeroberfläche steigert die Aufmerksamkeit des Besuchers und verhilft dem Projekt zu einem höheren Bekanntheitsgrad. Hierbei kommt eine moderne und attraktive Visualisierung der Daten zum Einsatz, die die Informationserfassung unterstützt. Durch das Bekanntwerden des Projekts erhofft sich unser Auftraggeber eine breite Verteilung der kommenden da-sense Android-App, mit der Benutzer Daten sammeln und auf die Datenbank transferieren können. Die Daten sind über die Webapplikation abrufbar.\\ \\
Die Maßnahmen, die wir ergreifen, um die beschriebenen Qualitätsmerkmale zu erreichen, sind in Abschnitt \ref{Masnahme:Benutzbarkeit} aufgeführt.
\subsection{Quellcode}
\label{Ziel:Codequalitaet}
>>Any fool can write code that a computer can understand. Good programmers write code that humans can understand.<< \cite{fowler}. \\
>>Any fool can write code that a computer can understand. Good programmers write code that humans can understand.<< \cite{fowler}. \\ \\
Der Quellcode des Projektes ist offen für Erweiterungen und wird von weiteren Gruppen genutzt. Daher muss darauf geachtet werden, dass sämtliche Codebausteine auch für Außenstehende lesbar und verständlich sind. Geplant ist die Veröffentlichung des Quellcodes, so dass auch unifremde Entwickler Zugriff haben und von der bestehenden Codequalität profitieren. Um dieses Ziel erreichen zu können, treffen wir folgende Vereinbarungen:
\begin{itemize}
\item Codedokumentation: \\
Jede von uns geschriebene Funktion besitzt einen Kommentarkopf der folgenden Form: \\
/** \\
* \textit{Description} \\
* @param \textit{paramtype} \\
* @return \textit{returntype} \\
* @tested \textit{boolean} \\
**/ \\
Wobei \textit{Description} durch einen funktionsbeschreibenden Text, \textit{paramtype} durch den Parametertyp, \textit{returntype} durch den Rückgabewert und \textit{boolean} durch den Wahrheitswert \glqq true\grqq\ bzw. \glqq false\grqq\ zu ersetzen sind. Somit erhalten die weiteren Entwickler schnell einen Überblick über die vorliegende Methode und ihre Funktionsweise.
Jede von uns geschriebene Funktion besitzt einen Kommentarkopf der folgenden Form: \\
/** \\
* \textit{Description} \\
* @param \textit{paramtype} \\
* @return \textit{returntype} \\
* @tested \textit{boolean} \\
**/ \\
Wobei \textit{Description} durch einen funktionsbeschreibenden Text, \textit{paramtype} durch den Parametertyp, \textit{returntype} durch den Rückgabewert und \textit{boolean} durch den Wahrheitswert \glqq true\grqq\ bzw. \glqq false\grqq\ zu ersetzen sind. Somit erhalten die weiteren Entwickler schnell einen Überblick über die vorliegende Methode und ihre Funktionsweise.
\item Struktur: \\
Wir trennen im Quellcode strikt HTML, JavaScript und PHP. Die Trennung erhöht die Lesbarkeit, vereinfacht die Fehlersuche und reduziert die Fehlerrate. Zusätzlich nutzen wir das \gls{MVC} zur sinnvollen Codestrukturierung.
\item Namenskonvention: \\ %Glossareintrag zu CamelCase schreiben
Wir benutzen die CamelCase Konvention, welche unter anderem in Java als Standard gilt und zu einer besseren Lesbarkeit von Bezeichnern beiträgt.
\end{itemize}
Die Maßnahmen, die wir ergreifen, um die beschriebenen Qualitätsmerkmale zu erreichen, sind in Abschnitt \ref{Masnahme:Codequalitaet} aufgeführt.
@ -251,6 +246,7 @@ Durch Punkt eins und zwei k
\subsection{Codequalität}
\label{Masnahme:Codequalitaet}
...
@ -342,8 +338,6 @@ Durch Punkt eins und zwei k
%
%
%
%\subsubsection{Logdaten Analyse}
%Die Logdaten Analyse steht in Zusammenhang mit der Benutzerstudie und wird somit auch erst am Ende des Projekts durchgeführt. Die Testdokumentation erfolgt somit im Anschluss und wird sich in der finalen Version dieses Dokuments (Abgabedatum 31.03.2012) befinden.
%
%
%\subsubsection{Codequalität}
@ -393,8 +387,7 @@ F
\addcontentsline{toc}{section}{Literatur}
\begin{thebibliography}{------}
% \bibitem[BSS+2008]{bss+:2008} Helmut Balzert, Christian Schäfer, Marion Schröder, Uwe Kern: \emph{Wissenschaftliches Arbeiten - Wissenschaft, Quellen, Artefakte, Organisation, Präsentation}, Witten: W3L, 2008
\bibitem[DBA]{DBA} \href{http://www.datenschutzbeauftragter-info.de/fachbeitraege/google-analytics-datenschutzkonform-einsetzen/}{http://www.datenschutzbeauftragter-info.de/fachbeitraege/google-analytics-datenschutzkonform-einsetzen/}
\bibitem[ISO/IEC 9126]{ISO/IEC 9126} International Organization for Standardization \emph{ISO/IEC 9126} \\Auszug: Wikipedia, \href{http://de.wikipedia.org/wiki/ISO/IEC_9126}{http://de.wikipedia.org/wiki/ISO/IEC\_9126}
% \bibitem[ISO9001]{iso:9001} International Organization for Standardization. \emph{ISO 9001}, 12.2008

View File

@ -1,12 +1,14 @@
QS-Dokument - Verbesserungsvorschläge:
-> Bei jeder Maßnahme muss aufgeführt werden: Was wird gemacht? Wie wird getestet? Wann wird es gemacht? Wer macht es? Und was wird im Fehlerfall gemacht?
-> Bei jeder Maßnahme muss aufgeführt werden:
- Was wird gemacht?
- Wie wird getestet?
- Wann wird es gemacht?
- Wer macht es?
- Und wie wird im Fehlerfall reagiert?
2.3: MVC-Pattern, strikte Trennung von php, javscript und html.
3.1: -> "Interoperabilität"
3.1 Funktionalität: -> "Interoperabilität"
"Um die Interoperabilität mit den einzelnen Webbrowsern sicherzustellen..."
@ -14,3 +16,22 @@ QS-Dokument - Verbesserungsvorschläge:
Auswertung dieser Fragebögen ermöglicht es uns, Rückschlüsse auf eventuell auftretende
Fehler in der Visiualisierung zu ziehen und zu beseitigen."
------------------------------------------------------------------------------------------------------------------
3.2 Benutzbarkeit:
3.2.1 Beobachtung:
3.2.2 Fragebogen:
------------------------------------------------------------------------------------------------------------------
3.3: Codequalität: