docs/Development-Case
view development-case.tex @ 7:1f955918cf53
lots of minor things; changed to english names
| author | meillo@marmaro.de |
|---|---|
| date | Mon, 21 Jan 2008 07:15:04 +0100 |
| parents | b9b93523dc05 |
| children | 5f939d777552 |
line source
1 % V. 1.0
2 \documentclass[a4paper,12pt,titlepage,DIV12,parskip]{scrreprt}
3 \setlength{\parskip}{3mm} %abstand abs\"{a}tze und listen
4 \usepackage{setspace}
5 \usepackage[utf8]{inputenc}
6 \usepackage{ngerman}
7 \usepackage[pdftex]{graphicx}
8 \usepackage[table]{xcolor}
9 %\usepackage{SIunits}
10 \usepackage{ragged2e,array}
11 \usepackage{wrapfig}
12 \usepackage[footnotesize]{caption2}
13 \usepackage{supertabular}
14 \usepackage{chngcntr}
15 \usepackage{longtable}
16 %\usepackage{lastpage}
17 \usepackage{caption2}
18 \usepackage[right]{eurosym}
19 %\usepackage{float}
20 \usepackage[ngerman]{varioref}
21 %\usepackage{enumitem}
22 \usepackage[colorlinks,linkcolor=black,urlcolor=blue,bookmarks,bookmarksopen,bookmarksnumbered]{hyperref}
24 %PDF Infos
25 \pdfinfo{
26 /Title (development-case.tex)
27 /Subject (Development Case)
28 %/Creator (TeX / pdfTeX)
29 %/Producer (Christoph Galler)
30 /Author (markus schnalke)
31 /CreationDate (D:20080113090000)
32 /ModDate (D:20080113090000)
33 }
35 %neues Kommando fuer Breitenangabe in der Tabelle mit vorgegebener Breite:
36 \newcommand{\preserveBackslash}[1]{\let\temp=\\#1\let\\=\temp}
37 \newcolumntype{R}[1]{>{\preserveBackslash\RaggedLeft}p{#1}}
38 % Font Familie
39 \renewcommand{\familydefault}{\sfdefault}
40 %\nofiles
41 % Fuer tabellenkopf
42 \newcommand{\hoehe}{\parbox[1pt][2em][c]{0cm}{}}
44 \definecolor{gray09}{gray}{0.9}
45 \definecolor{gray07}{gray}{0.7}
47 %Counternummerierung \"{a}ndern -> 1.1 2.1 3.1 etc.
48 \counterwithin{section}{chapter}
50 % Name f\"{u}r autoref bei figure Umgebungen: Abbildung x.z
51 \renewcommand{\figureautorefname}{Abbildung}
52 \renewcommand{\chapterautorefname}{Kapitel}
53 \renewcommand{\sectionautorefname}{Unterkapitel}
54 \renewcommand{\tableautorefname}{Tabelle}
57 % Textkoerperhoehe
58 \setlength{\headsep}{0.6cm}
59 \addtolength{\textheight}{0.9cm}
60 \setlength{\footskip}{0.9cm}
62 % Kopf- und Fu{\ss}zeile
63 \setlength{\headheight}{2cm}
64 \usepackage[automark]{scrpage2}
65 \automark[section]{section}
66 \setheadwidth{15.8cm}
67 \ihead{\headmark}
68 \ihead{Online Seminarbuchungssystem}
69 \chead{{\color{blue}\color{black}\rule[-10pt]{18.4cm}{0.1pt}\color{black}}}
70 \ohead{\headmark}
71 \setfootwidth[-74pt]{18.3cm}
72 \setfootsepline[foot]{.1pt}
73 \ifoot{} %~~~~~~~~~~~~~~~~~~~\footnotesize Christoph Galler}
74 \cfoot{}
75 \ofoot{\footnotesize Seite \thepage} % ~von \pageref{LastPage}}
76 \renewcommand*{\chapterpagestyle}{scrheadings}
77 \renewcommand*{\indexpagestyle}{scrheadings}
78 \pagestyle{scrheadings}
80 % Kapitel nicht zu tief beginnen
81 \renewcommand*\chapterheadstartvskip{\vspace*{0cm}}
84 \begin{document}
86 %
87 % Titelei
88 %
89 \begin{titlepage}
90 \vspace*{-0cm}
91 {\hspace*{11cm}\includegraphics*[scale=0.5]{pictures/png/logo_hsu_klein}}
92 \begin{center}
93 \vspace*{1.9cm}
94 {\normalsize\textsc{Gruppe 2: Rui Gu, Wei Zhu, Veysel Imamoglu, Dimitar Dimitrov, \\Karl Oppermann, Nathalie Hrycej, Markus Schnalke, Christoph Galler}} \par
95 \vspace*{0.6cm}
96 \Large \textbf{Online-Seminarbuchungssystem} \par
97 \Huge \textbf{Development Case} \par
98 \vspace*{0.8cm}
99 \Large \textbf{Verfasser: Markus Schnalke} \par
100 {\large{} \par
101 \vspace*{0.7cm}
102 {\textsc{Ulm, \today}}} \par
103 \vspace*{5cm}
104 {\normalsize\textsc{Betreut durch: \\
105 Prof. Dr. Klaus Baer \\
106 Hochschule Ulm \\
107 Prittwitzstra{\ss}e 10\\
108 89075 Ulm\\}}
109 \end{center}
110 \vfill
111 \end{titlepage}
113 % \addsec{Bitte beachten}
114 Version vom \today: Das Dokument befindet sich noch im Aufbau, \"{A}nderungen sind dadurch jederzeit M\"{o}glich.
115 \addsec{Version dieses Dokuments}
116 \begin{tabular}{|p{1.5cm}|p{3.cm}|p{1.6cm}|p{2cm}|p{1.4cm}|p{4cm}|}
117 \hline
118 \multicolumn{5}{|l}{\parbox[0pt][3.4em][l]{12cm}{\vspace{0.2cm}\large Dokument: \textbf{Development Case} \newline \emph{ Online-Seminarbuchungssystem}}} & \multicolumn{1}{r|}{\parbox[0pt][3.4em][r]{1.9cm}{\includegraphics*[scale=0.25]{pictures/png/logo_hsu}}} \\
119 \hline\hline
120 \hoehe{\textbf{Version}} & \textbf{Person} & \textbf{Aktion} & \textbf{Datum} & \textbf{Status} & \textbf{Kommentar} \\
121 \hline\hline
122 0.1 & Markus Schnalke & E & 2007-11-27 & A & Erste Version \\ \hline
123 0.2 & Markus Schnalke & AE & 2008-01-13 & A & Neue Struktur des Dokuments \\ \hline
124 0.3 & Markus Schnalke & AE & 2008-01-14 & A & Glossar erstellt \\ \hline
125 0.4 & Markus Schnalke & AE & 2008-01-16 & A & Struktur überarbeitet; Glossar ausgelagert \\ \hline
126 0.4.1 & Karl Oppermann & QS & 2008-01-17 & A & Allgemeines Review \\ \hline
127 0.5 & Markus Schnalke & AE & 2008-01-18 & O & \\ \hline
128 \end{tabular}
129 {\footnotesize\vspace*{-0.1cm}Aktion: E – Erstellung; AE – \"{A}nderung; QS – Review; AB – Abnahme} \par
130 {\footnotesize\vspace*{-0.4cm} Status: O – Offen; D – Diskussion; A – Akzeptiert}
131 \clearpage
133 % Inhaltsverzeichnis
134 \setcounter{tocdepth}{3}
135 %\renewcommand\contentsname{"Uberblick}
136 \tableofcontents
138 \clearpage
143 % Content
147 \chapter{Einleitung}
149 \section{Zweck des Dokuments}
151 Dieses Dokument beschreibt den Entwicklungsprozess nach dem wir in unserem Projekt vorgehen.
154 \section{Definitionen und Abkürzungen}
156 Die verwendeten Begriffe sind im Projekt-Glossar erklärt. Bei Bedarf kann dort nachgeschlagen werden.
158 % Im Glossar sind: Workflow Entwicklungsprozess Zyklus Iteration Phase RUP Iterativer Entwicklungsprozess Manntag Release
161 \section{Verweise auf andere Artefakte}
163 \begin{itemize}
164 \item \textbf{Glossary}: Dort werden die verwendeten Fachbegriffe erklärt.
165 \item \textbf{Software Development Plan}: Der \emph{Development Case} ist ein Unterdokument des \emph{Software Development Plans}.
166 \item \textbf{Project Plan}: Die konkrete zeitliche Planung. (Der Project Plan findet sich im Software Development Plan.)
167 \item
168 \item
169 \item
170 \end{itemize}
176 %%%%%%%%%%%%%%
177 \chapter{Entwicklungsprozess}
179 \section{Überblick}
181 Wir werden unser Projekt nach dem \emph{Rational Unified Process} (kurz RUP) entwickeln.
183 Der RUP ist ein dynamischer und iterativer Entwicklungsprozess, der das Projekt in zwei Dimensionen (zeitlich und inhaltlich) betrachtet.
184 Er ist ausführlich spezifiziert und umfangreich dokumentiert.
186 An sich ist der RUP für große Projekte, mit vielen Mannjahren, ausgelegt. Für unser kleines Projekt (90 Manntage) ist er eher weniger gut geeignet. Wir haben uns trotzdem für den RUP entscheiden, da wir ihn in der Vorlesung Softwaretechnik 1 ausführlich behandelt hatten und wir dieses Theoriewissen nun in der Praxis anwenden wollen.
188 Um einen Entwicklungsprozess für ein Projekt anzuwenden, muss er für eben dieses Projekt angepasst werden. Als Daumenregel kann man sagen: Je aufwändiger ein Prozess ist, desto stärker wird er auf ein spezifisches Projekt zurechtgeschneidert werden müssen.
190 Wir haben also diesen mächtigen und umfangreichen Rational Unified Process für unser kleines Projekt abgespeckt und angepasst. Diese Anpassungen betreffen dabei natürlich beide Dimensionen, die zeitliche (Zyklen, Phasen, Iterationen) und die inhaltliche (Workflows).
192 Wie unsere Adaptation des RUP genau aussieht, das beschreibt diese Dokument.
195 \newpage
196 \section{Der RUP auf einen Blick}
198 Natürlich kann man diesen umfassenden Entwicklungsprozess nicht in einem Bild komplett abbilden, jedoch zeigt die nachfolgende Grafik doch sehr schön, wie die Entwicklung im Bezug auf die zwei Dimensionen aussieht. Dieser Übersichtplan, soll primär eine greifbare Vorstellung des Prozesses geben. Sie kann quasi als ``Landkarte'' für die in diesem Dokument beschriebene ``Landschaft'' zur Hilfe genommen werden.
200 \begin{figure}[htb]
201 \centering
202 \includegraphics[width=10cm]{pictures/png/RationalUnifiedProcess.png}
203 \caption{Übersicht über einen Zyklus des RUP}
204 \label{fig:rationalunifiedprocess}
205 \end{figure}
214 %%%%%%%%%%%%%%
215 \chapter{Zeitliche Dimension}
217 \section{Anpassungen}
219 Wir werden in unserem Projekt drei Zyklen durchführen. Anschließend wird das Projekt nicht abgeschlossen sein. Für unser Team endet dann zwar die Arbeit an diesem Projekt, ein anderes Team kann die Arbeit zu einem beliebigen späteren Zeitpunkt wieder aufgreifen und daran weiterarbeiten.
220 % FIXME: was ist das/unser Projekt (3Zyklen oder das komplette)?
222 Jeder der drei Zyklen wird circa vier Wochen (18 Manntage %FIXME
223 ) umfassen. An dessen Ende jeweils ein Release stehen wird. (Näheres zu den Releases findet sich im \emph{Software Development Plan}.)
225 Iterationen innerhalb der Zyklen werden wir, auf Grund der kurzen Zyklen, komplett außen vor lassen.
227 Die einzelnen Phasen in den Zyklen versuchen wir, so gut es geht, zu berücksichtigen.
231 \subsection{Probleme und Konsequenzen}
233 Der RUP ist sehr umfangreich und mächtig. Unser Projekt dagegen, ist ziemlich klein, und so bedarf es größerer Anpassungen, um den Entwicklungsprozess unserem Projekt entsprechend zurechtzustutzen. %FIXME: mit "stuzen" oder "stutzen"??
235 Hier ein Anhaltspunkt, um welche Größenordnungen es dabei geht: Unsere 90 Manntage, entsprechen realistischerweise eher einer einzelnen Iteration, als den drei Zyklen, die wir für uns geplant haben.
237 Dabei muss auch bedacht werden, dass pro Phase ganz grob nur etwa 4 Manntage (d.h. circa 4 Stunden pro Person) zur Verfügung stehen. Wenn man auch an die unterschiedlichen Arbeitszeiten der einzelnen Personen denkt, so dürfte klar sein, dass wir unserem Konzept, dem RUP, nur annäherungsweise folgen können.
239 Wir werden deshalb ein paar Ungenauigkeiten bei unserem Verhalten im Kauf nehmen; versuchen aber natürlich, uns möglichst nahe an die Leitlinie RUP zu halten.
241 Trotz all dieser Schwierigkeiten finden wir es wichtig, diesen Prozess zu wählen, weil die theoretischen Inhalte der Vorlesung ``Softwaretechnik 1'' erst durch ihre tatsächliche Anwendung im realen Projekt vollständig zur Entfaltung kommen. So befassen wir uns intensiv (theoretisch sowie praktisch) mit einem Entwicklungsprozess, anstatt zwei Prozesse nur teilweise kennenzulernen.
244 \section{Konkrete Projektplanung}
246 Die konkrete Planung der einzelnen Zyklen und ihrer Meilensteine sollen sich laut RUP im \emph{Projekt Plan} befinden. Dieser gibt eine zeitliche und inhaltliche Komplettübersicht über das Projekt.
248 Zudem ist nach dem RUP auch ein \emph{Iterations Plan} definiert, in dem ausgehend von der aktuellen Iteration, jeweils die nächste geplant wird. Dieses Artefakt existiert bei uns nicht, da wir keine Iterationen haben. Wir haben die Inhalte unseres Iterations Plans mit denen des Projekt Plans verschmolzen, und sie in den \emph{Software Development Plan} integriert.
256 %%%%%%%%%%%%%%%%%%%%
257 \chapter{Inhaltliche Dimension}
259 Diese zweite Dimension beschreibt die inhaltliche Seite der Entwicklung. Hier wird genau festgelegt, \emph{wer} \emph{wie} \emph{was} \emph{wann} macht.
261 Dabei gibt es vier Elemente:
262 \begin{itemize}
263 \item Rolle, das \emph{Wer}. Die \emph{Rolle} ist eine Verantwortlichkeit, die jemand hat. Eine einzelne Person, oder eine Gruppe kann eine solche Rolle haben. Andererseits kann auch eine Person mehrer Rollen haben. In jedem Fall muss klar sein, wer welche Rolle hat. Diese Information findet sich bei uns im \emph{Organigramm} (siehe Software Development Plan).
264 \item Aktivität, das \emph{Wie}. Eine Aktivität ist ein bestimmte Arbeitseinheit, die der Arbeiter mit einer bestimmten Rolle erledigen muss. Üblicherweise soll dabei ein Artefakt erstellt oder aktualisiert werden.
265 \item Artefakt, das \emph{Was}. Ein Artefakt ist Information, die von einem Prozess verwendet, verändert oder produziert wird. Artefakte sind häufig Diagramme, Quellcode, Textdokumente und ähnliches.
266 \item Workflow, das \emph{Wann}. Ein Workflow ist eine Aneinanderreihung von Aktivitäten, die ein Ergebnis von messbarem Wert erzeugen. Im Worflow werden die ersten drei Elemente (Rolle, Aktivität und Artefakt) zu einer direkt wertschaffenden Struktur zusammengebaut.
267 \end{itemize}
269 \section{Core Workflows}
271 \subsection{Business Modeling}
272 (Geschäftsprozessmodellierung)
274 Dokumentation der relevanten Geschäftsprozesse in Use Cases, mit dem Ziel eines gemeinsamen Verständnisses zwischen Entwicklern und Anwendern.
276 \paragraph{Artefakte}
277 \begin{itemize}
278 \item Glossary
279 \item Business Use Cases
280 \end{itemize}
284 \subsection{Requirements}
285 (Anforderungen)
287 Ermitteln, was das System leisten soll. Die funktionalen Anforderungen sollen erfasst werden.
289 \paragraph{Artefakte}
290 \begin{itemize}
291 \item Vision
292 \item Use Case
293 \item Use Case Diagram
294 \end{itemize}
298 \subsection{Analysis \& Design}
299 (Analyse \& Design)
301 Aufbau und Technologie des Systems festlegen. Festlegung wie wird das System realisiert wird.
303 \paragraph{Artefakte}
304 \begin{itemize}
305 \item Software Architecture Document
306 \end{itemize}
310 \subsection{Implementation}
311 (Implementierung)
313 Systemteile entwickeln und zusammenfügen. Komponententests.
315 \paragraph{Artefakte}
318 \subsection{Testing}
319 (Test)
321 Test des Zusammenspiels der Komponenten. Funktionsweise des Systems gegen die Anforderungen prüfen.
323 Da wir eine neue Technologie erkunden, macht Test keinen wirklichen Sinn. Unser Ziel ist es, in kurzer Zeit möglichst viele Bereiche und Möglichkeiten zu erkunden. Dabei würde Testing nur bremsen. Unser Hauptaugenmerk ist es vorran zu kommen, nicht komplett fehlerfreie Ergebnisse zu liefern, deshalb verzichten wir komplett auf diesen Workflow.
327 \subsection{Deployment}
328 (Verteilung)
330 Auslieferung des Systems an den Kunden und Inbetriebnahme. Schulung der Benutzer.
332 \paragraph{Artefakte}
337 \section{Supplymentary Workflows} %FIXME: korrekter Name?
339 \subsection{Configuration \& Changemanagement}
340 (Konfigurations- \& Änderungsmanagement)
342 Verwaltung der zum Projekt gehörenden Daten. Versionierung und Konsistenz.
344 \paragraph{Artefakte}
345 \begin{itemize}
346 \item Project Repository
347 \end{itemize}
350 \subsection{Projectmanagement}
351 (Projektmanagement)
353 Zwischen konkurrierenden Zielen vermitteln. Auf Risiken reagieren.
355 \paragraph{Artefakte}
356 \begin{itemize}
357 \item Software Development Plan (Project Plan)
358 \item Risklist
359 \end{itemize}
362 \subsection{Environment}
363 (Entwicklungsumgebung)
365 Bereitstellung von Hardware, Software und Know-How.
367 \paragraph{Artefakte}
368 \begin{itemize}
369 \item Development Case
370 \end{itemize}
384 \appendix
385 %\chapter{Glossar}
386 \chapter{Quellen}
387 \begin{itemize}
388 \item Dokumentation zum \emph{Rational Unified Process} (\texttt{http://www-306.ibm.com/software/awdtools/rup/})
389 \item Skript von Herrn Baer zur Vorlesung \emph{Softwaretechnik 1} an der Hochschule Ulm
390 \item http://wikipedia.org
391 \item \emph{Rational Unified Process - Best Practices for Software Development Teams}
392 \end{itemize}
394 Anmerkung zur Abbildung \ref{fig:rationalunifiedprocess}: This image is from the Rational Unified Process (software product) version 2003.06.12.01. This image is copyright by Rational Software Corporation, now a division of IBM.
398 \end{document}
403 %%%%%%%% HowTo %%%%%%%%%%
405 % picture block
406 \begin{figure}[h]
407 \includegraphics[scale=0.65]{pictures/png/logistiksicht_v6}
408 \caption{Logistiksicht für SAP}
409 \label{fig:logistiksicht}
410 \end{figure}
412 % picture inline
413 \begin{wrapfigure}[11]{r}[0pt]{6.4cm}
414 \centering %OPTIONAL
415 \includegraphics[scale=0.7]{pictures/png/werkdresden}
416 \caption{OptiBoard Werk Dresden}
417 \end{wrapfigure}
419 % tabellen
420 \begin{table}[h]
421 \centering
422 \begin{tabular}{p{4cm}|p{3cm}|p{3.3cm}}
423 \rowcolor{gray07} \textbf{Teil} & \textbf{Menge} & \textbf{Einheit}\\
424 \hline
425 \rowcolor{white} LED-Block & 105 & Stück\\
426 \rowcolor{gray09} Feder & 105 & Stück\\
427 \rowcolor{white} Platine & 1 & Stück\\
428 \rowcolor{gray09} Chip & 1 & Stück\\
429 \rowcolor{white} Kabel & 1 & Stück\\
430 \rowcolor{gray09} Kunststoffgranulat & 350 & Gramm\\
431 \end{tabular}
432 \caption{Mengenübersichtstückliste OptiBoard Pro}
433 \label{tbl:mengenPro}
434 \end{table}