genofire/hs_monolith
genofire
/
hs_monolith
Archived
1
0
Fork 0
Code Releases Activity

[Task] Enlarging of the Documentation 

Adding chapter for a GettingStarted Guide and some rules for getting
started with the service
This commit is contained in:
mlabusch 2017-04-07 10:24:59 +02:00
parent 8103a9768c
commit c974de7690
5 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
KSS-Dokumentation/Doku_Microservice_Warenwirtschaft/Doku_Microservice_Warenwirtschaft_MLabusch_MMuller.tex
View File

@ -29,13 +29,15 @@
\input{./Kapitel/DokStruktur} \newpage \input{./Kapitel/DokStruktur} \newpage
\input{./Kapitel/Anforderungen} \newpage \input{./Kapitel/Anforderungen} \newpage
\input{./Kapitel/Struktur} \newpage \input{./Kapitel/Struktur} \newpage
\input{./Kapitel/Implementierungsregeln}\newpage
\input{./Kapitel/Testfalle} \newpage \input{./Kapitel/Testfalle} \newpage
\clearpage \clearpage
\appendix \appendix
\phantomsection \phantomsection
\addcontentsline{toc}{section}{\appendixname} \addcontentsline{toc}{section}{\appendixname}
\input{./Kapitel/GettingStarted} \newpage
\input{./Kapitel/Handout} \newpage \input{./Kapitel/Handout} \newpage
\input{./Kapitel/Testprotokoll} \input{./Kapitel/Testprotokoll}

2
KSS-Dokumentation/Doku_Microservice_Warenwirtschaft/Kapitel/DokStruktur.tex
View File

@ -2,4 +2,4 @@
\label{sec: Dokumentationsstruktur} \label{sec: Dokumentationsstruktur}
Für die Dokumentation des Microservice Warenwirtschaft wurden eine Kombination aus zwei Dokumenten gewählt. Zum einen beschreibt ein Handout auf einer Seite die Funktionen des Admin-Frontends für den Benutzer. Diese sehr kurze Dokumentenform wurde gewählt, da Benutzer häufig nicht gewillt sind, umfangreiche Anleitungen zu lesen um eine Anwendung nutzen zu können. Vielmehr wollen sie schnell einen Überblick der Kernfunktionalitäten erhalten. Zu diesem Zweck arbeitet das Handout mit einem aufbereiteten Screenshot des Admin-Frontends und einer Beschreibung der Funktionen in Stichpunkten. \par Für die Dokumentation des Microservice Warenwirtschaft wurden eine Kombination aus zwei Dokumenten gewählt. Zum einen beschreibt ein Handout auf einer Seite die Funktionen des Admin-Frontends für den Benutzer. Diese sehr kurze Dokumentenform wurde gewählt, da Benutzer häufig nicht gewillt sind, umfangreiche Anleitungen zu lesen um eine Anwendung nutzen zu können. Vielmehr wollen sie schnell einen Überblick der Kernfunktionalitäten erhalten. Zu diesem Zweck arbeitet das Handout mit einem aufbereiteten Screenshot des Admin-Frontends und einer Beschreibung der Funktionen in Stichpunkten. \par
Auf der anderen Seite muss der Microservie auch für Entwickler dokumentiert sein, hierfür wurde diese Dokumentation angelegt. Sie beginn anstelle eines Abstract mit einem Steckbrief des Microservice, der dessen grundlegende Struktur und Funktionalität kurz beschreibt. In dem eigentlichen Dokument werden dann zunächst die Anforderungen an den Microservice beschrieben, da ihre Umsetzung das primäre Ziel der Entwicklung ist. Weiter werden der Microservice und seine Code-Struktur detaillierter beschrieben sowie die gewählten Blackbox-Testfälle dokumentiert. Der Anhang dieser Dokumentation umfasst das Handout des Admin-Frontends sowie ein beispielhaftes Testprotokoll. Auf Details wir ein Abkürzungs- oder Literaturverzeichnis wurde in dieser Dokumention bewusst verzichtet, um sie kurz zu halten. Zitate und Verweise werden hier in Form von Fußnoten integriert. Auf der anderen Seite muss der Microservie auch für Entwickler dokumentiert sein, hierfür wurde diese Dokumentation angelegt. Sie beginn anstelle eines Abstract mit einem Steckbrief des Microservice, der dessen grundlegende Struktur und Funktionalität kurz beschreibt. In dem eigentlichen Dokument werden dann zunächst die Anforderungen an den Microservice beschrieben, da ihre Umsetzung das primäre Ziel der Entwicklung ist. Weiter werden der Microservice mit seinem Aufbau, den Schnittstellen und der Anpassung des gegebenen Monolithen beschrieben. Es folgt die Dokumentation von Implementierungsregeln und der gewählten Blackbox-Testfälle. Der Anhang dieser Dokumentation umfasst einen Anleitung für den Start des Microservice, das Handout des Admin-Frontends sowie ein beispielhaftes Testprotokoll. Auf Details wir ein Abkürzungs- oder Literaturverzeichnis wurde in dieser Dokumention bewusst verzichtet, um sie kurz zu halten. Zitate und Verweise werden hier in Form von Fußnoten integriert.

2
KSS-Dokumentation/Doku_Microservice_Warenwirtschaft/Kapitel/GettingStarted.tex Normal file
View File

@ -0,0 +1,2 @@
\section{Getting Started}
\label{sec: Getting Started}

2
KSS-Dokumentation/Doku_Microservice_Warenwirtschaft/Kapitel/Implementierungsregeln.tex Normal file
View File

@ -0,0 +1,2 @@
\section{Implementierungsregeln}
\label{sec: Implementierungsregeln}

7
KSS-Dokumentation/Doku_Microservice_Warenwirtschaft/Kapitel/Struktur.tex
View File

@ -1,5 +1,5 @@
\section{Struktur des Microservice} \section{Architektur des Microservice}
\label{sec: Struktur des Microservice} \label{sec: Architektur des Microservice}
\begin{figure}[H] \begin{figure}[H]
\begin{center} \begin{center}
@ -15,6 +15,9 @@
\item \textcolor{red}{ToDo: kurze Beschreibung der Programmstruktur und genauere Beschreibung der Einzelteile in Unterkapiteln} \item \textcolor{red}{ToDo: kurze Beschreibung der Programmstruktur und genauere Beschreibung der Einzelteile in Unterkapiteln}
\end{itemize} \end{itemize}
\subsection{Schnittstellen}
\label{subsec: Schnittstellen}
\subsection{Presentation Layer} \subsection{Presentation Layer}
\label{subsec: Presentation Layer} \label{subsec: Presentation Layer}