Commit a7a43068 authored by andreas.fried's avatar andreas.fried
Browse files

Fix numerous typos and other small errors.

parent ec0b2d71
...@@ -61,10 +61,10 @@ Git-Tipps: ...@@ -61,10 +61,10 @@ Git-Tipps:
\item \href{http://eagain.net/articles/git-for-computer-scientists/} \item \href{http://eagain.net/articles/git-for-computer-scientists/}
{Git for Computer Scientists}: {Git for Computer Scientists}:
\enquote{Quick introduction to git internals for people who are not scared by words like Directed Acyclic Graph.} \enquote{Quick introduction to git internals for people who are not scared by words like Directed Acyclic Graph.}
\item Vermeide den Parameter \texttt{--force} bzw. \texttt{-f}. \item Vermeide den Parameter \texttt{-{}-force} bzw. \texttt{-f}.
Häufig schiebst du damit Probleme nur deinen Teamkollegen zu. Häufig schiebst du damit Probleme nur deinen Teamkollegen zu.
\item Benutze den Parameter \texttt{--rebase} bei einem \texttt{git pull}, \item Benutze den Parameter \texttt{-{}-rebase} bei einem \texttt{git pull},
das vermeidet es, dass alles voller merge-commits ist. damit vermeidest du, dass alles voller merge-commits ist.
Alternativ kann man das (ab git 1.7.9) auch als globalen Standard einstellen Alternativ kann man das (ab git 1.7.9) auch als globalen Standard einstellen
mit \texttt{git config --global pull.rebase true}. mit \texttt{git config --global pull.rebase true}.
\end{itemize} \end{itemize}
...@@ -90,24 +90,24 @@ weil es sich gut mit Versionskontrollsystemen vereinbaren lässt ...@@ -90,24 +90,24 @@ weil es sich gut mit Versionskontrollsystemen vereinbaren lässt
und man hier schon für die Bachelorarbeit üben kann. und man hier schon für die Bachelorarbeit üben kann.
Office o.ä. ist aber auch möglich. Office o.ä. ist aber auch möglich.
Statt den normalen Dokumentklassen, Statt den normalen Dokumentklassen
empfehlen wir vor allem für deutsche Dokumente empfehlen wir vor allem für deutsche Dokumente
die KOMA-Scriptklassen zu verwenden. die KOMA-Scriptklassen zu verwenden.
Diese sind flexibler und besser für deutsche Typografie ausgelegt. Diese sind flexibler und besser für deutsche Typografie ausgelegt.
Das bedeutet deutsche Dokumente starten Das bedeutet deutsche Dokumente starten
mit der folgenden Deklaration. mit der folgenden Deklaration:
\begin{verbatim} \begin{verbatim}
\documentclass[parskip=full]{scrartcl} \documentclass[parskip=full]{scrartcl}
\end{verbatim} \end{verbatim}
Das \texttt{parskip=full} sorgt Das \texttt{parskip=full} sorgt
für eine Absatzabstand von einer Zeile für einen Absatzabstand von einer Zeile
und die erste Zeile eines Absatzes wird nicht eingerückt. und die erste Zeile eines Absatzes wird nicht eingerückt.
Das ist im Deutsch das übliche Format, Das ist im Deutschen das übliche Format,
aber nicht im Englischen. aber nicht im Englischen.
Weitere für (deutsche) \LaTeX-Dokument fast immer gute Einstellungen: Weitere für (deutsche) \LaTeX-Dokumente fast immer gute Einstellungen:
\begin{verbatim} \begin{verbatim}
\usepackage[utf8]{inputenc} % use utf8 file encoding for TeX sources \usepackage[utf8]{inputenc} % use utf8 file encoding for TeX sources
...@@ -121,10 +121,10 @@ Weitere für (deutsche) \LaTeX-Dokument fast immer gute Einstellungen: ...@@ -121,10 +121,10 @@ Weitere für (deutsche) \LaTeX-Dokument fast immer gute Einstellungen:
\usepackage{csquotes} % provides \enquote{} macro for "quotes" \usepackage{csquotes} % provides \enquote{} macro for "quotes"
\end{verbatim} \end{verbatim}
Die Dokumentation der Pakete ist häufig lesenswert. Die Dokumentation der Pakete ist häufig lesenswert,
Insbesondere bei den Paketen hyperref und scrguide (KOMA-Script). insbesondere bei den Paketen hyperref und scrguide (KOMA-Script).
Wer TeXLive per Kommandozeile benutzt kann einfach Wer TeXLive per Kommandozeile benutzt,
\texttt{texdoc scrguide} aufrufen. kann einfach \texttt{texdoc scrguide} aufrufen.
Zum Erzeugen eines PDFs aus den \LaTeX-Sourcen Zum Erzeugen eines PDFs aus den \LaTeX-Sourcen
empfehlen wir einen Wrapper wie \texttt{latexmk} zu verwenden. empfehlen wir einen Wrapper wie \texttt{latexmk} zu verwenden.
...@@ -140,7 +140,7 @@ Technisches Schreiben ist wichtig für alle Arten von technischen und wissenscha ...@@ -140,7 +140,7 @@ Technisches Schreiben ist wichtig für alle Arten von technischen und wissenscha
also auch API-Dokumentation, Bachelorarbeit, Pflichtenheft und Testbericht. also auch API-Dokumentation, Bachelorarbeit, Pflichtenheft und Testbericht.
Es bedeutet vor allem eine präzise Ausdrucksweise Es bedeutet vor allem eine präzise Ausdrucksweise
und widerspricht dabei einigen Regeln, und widerspricht dabei einigen Regeln,
die man im Deutschunterricht gelernt hat. die man im Deutsch\-unterricht gelernt hat.
Ein paar praktische Tipps: Ein paar praktische Tipps:
\begin{itemize} \begin{itemize}
...@@ -149,8 +149,8 @@ Ein paar praktische Tipps: ...@@ -149,8 +149,8 @@ Ein paar praktische Tipps:
ein schlechter Ersatz für einen ungenauen Begriff. ein schlechter Ersatz für einen ungenauen Begriff.
\item Nebensatzkonstruktionen vermeiden; Hauptsätze verwenden! \item Nebensatzkonstruktionen vermeiden; Hauptsätze verwenden!
\item Definiere Begriffe klar und verwende keine Synonyme. \item Definiere Begriffe klar und verwende keine Synonyme.
Synonyme lassen offen, ob genau das gleiche gemeint ist Synonyme lassen offen, ob genau das Gleiche gemeint ist
oder nur etwas ähnliches. oder nur etwas Ähnliches.
\item Abkürzungen sollten bei der ersten Verwendung (EV) \item Abkürzungen sollten bei der ersten Verwendung (EV)
ausgeschrieben werden. Nach der EV reicht dann die Kurzform. ausgeschrieben werden. Nach der EV reicht dann die Kurzform.
\item Versuche konkrete Zahlen und Namen anzugeben. \item Versuche konkrete Zahlen und Namen anzugeben.
...@@ -188,8 +188,8 @@ Ein paar Hinweise für die Kollquien bzw. für Präsentation allgemein. ...@@ -188,8 +188,8 @@ Ein paar Hinweise für die Kollquien bzw. für Präsentation allgemein.
\item Vor dem eigenen Team üben und konstruktiv gegenseitig kritisieren. \item Vor dem eigenen Team üben und konstruktiv gegenseitig kritisieren.
Oft sehen die Kollegen Ticks, die man selbst nicht wahrnimmt. Oft sehen die Kollegen Ticks, die man selbst nicht wahrnimmt.
Beispielsweise häufige Ähs, häufiges Wegschauen vom Publikum, Beispielsweise häufige Ähs, häufiges Wegschauen vom Publikum,
verschränkte Arme, Nuscheln, nervöses herumlaufen, etc. verschränkte Arme, Nuscheln, nervöses Herumlaufen, etc.
\item Lauf und deutlich sprechen. \item Laut und deutlich sprechen.
\item 10 Minuten sind nicht lange, \item 10 Minuten sind nicht lange,
aber man kann viel Information darin unterbringen. aber man kann viel Information darin unterbringen.
\item Prof. Snelting achtet sehr auf die Zeit. \item Prof. Snelting achtet sehr auf die Zeit.
...@@ -260,9 +260,9 @@ Und noch einige generelle Anforderungen an das Pflichtenheft. ...@@ -260,9 +260,9 @@ Und noch einige generelle Anforderungen an das Pflichtenheft.
dass das Ergebnis euren Vorstellungen entspricht? dass das Ergebnis euren Vorstellungen entspricht?
Abweichungen von euren Vorstellung dürfen nur kritisiert werden, Abweichungen von euren Vorstellung dürfen nur kritisiert werden,
wenn dadurch Testfälle fehlschlagen. wenn dadurch Testfälle fehlschlagen.
\item Das Pflichtenheft sollte auch von nicht technisch-versierten Menschen \item Das Pflichtenheft sollte auch von nicht technisch versierten Menschen
zu großen Teilen verstanden werden können. zu großen Teilen verstanden werden können.
Am besten jemand fach-fremden zum Lesen geben Am besten jemand fachfremdem zum Lesen geben
und danach Verständnisfragen stellen. und danach Verständnisfragen stellen.
\item Das Pflichtenheft ist das entscheidendste Dokument \item Das Pflichtenheft ist das entscheidendste Dokument
zwischen Kunde und Entwickler am Ende eines Projekts. zwischen Kunde und Entwickler am Ende eines Projekts.
...@@ -299,19 +299,19 @@ Sinnvolle Änderungen könnten sein: ...@@ -299,19 +299,19 @@ Sinnvolle Änderungen könnten sein:
\paragraph{T1337} Einloggen \paragraph{T1337} Einloggen
\begin{enumerate} \begin{enumerate}
\item \begin{description} \item \begin{description}
\item[Stand] Offenes browserfenster. \item[Stand] Offenes Browserfenster.
\item[Aktion] Benutzer gibt \enquote{facebook.com} in die Kopfzeile \item[Aktion] Benutzer gibt \enquote{facebook.com} in die Kopfzeile
ein und drückt Enter. ein und drückt Enter.
\item[Reaktion] Der browser wechselt zur Facebook Frontseite. \item[Reaktion] Der Browser wechselt zur Facebook-Frontseite.
\end{description} \end{description}
\item \begin{description} \item \begin{description}
\item[Stand] Facebook Frontseite ist geladen. \item[Stand] Facebook-Frontseite ist geladen.
Loginmöglichkeit oben rechts. Loginmöglichkeit oben rechts.
\item[Aktion] Benutzer gibt \enquote{zuckerberg@facebook.com} als Email \item[Aktion] Benutzer gibt \enquote{zuckerberg@facebook.com} als Email
und \enquote{admin} als Passwort ein. und \enquote{admin} als Passwort ein.
Dann klickt der Benutzer auf den \enquote{Log In} Knopf. Dann klickt der Benutzer auf den \enquote{Log In} Knopf.
\item[Reaktion] Erfolgreich eingeloggt. \item[Reaktion] Erfolgreich eingeloggt.
Der browser wird zur Newsfeedseite des Benutzers umgeleitet. Der Browser wird zur Newsfeedseite des Benutzers umgeleitet.
\end{description} \end{description}
\end{enumerate} \end{enumerate}
Die Testfallszenarien sind in Entwurfs- und Qualitätssicherungsphase nützlich. Die Testfallszenarien sind in Entwurfs- und Qualitätssicherungsphase nützlich.
...@@ -360,11 +360,11 @@ Design is the art of separation, grouping, abstraction, and hiding. The fulcrum ...@@ -360,11 +360,11 @@ Design is the art of separation, grouping, abstraction, and hiding. The fulcrum
anhand von Sequenzdiagrammen. anhand von Sequenzdiagrammen.
Beispielsweise bieten sich Testszenarien aus dem Pflichtenheft hier an. Beispielsweise bieten sich Testszenarien aus dem Pflichtenheft hier an.
Wir empfehlen Sequenzdiagramme möglichst früh zu erstellen, Wir empfehlen Sequenzdiagramme möglichst früh zu erstellen,
dann dabei werden die Schnittstellen zwischen Packages und Klassen klar. denn dabei werden die Schnittstellen zwischen Packages und Klassen klar.
\item Aufteilung in Klassen/Pakete \item Mit Blick auf den Implementierungsplan:
Aufteilung in Klassen/Pakete,
die unabhängig voneinander implementiert und getestet werden können. die unabhängig voneinander implementiert und getestet werden können.
Mit Blick auf den Implementierungsplan. \item Änderungen zum Pflichtenheft, z.B. gekürzte Wunschkriterien.
\item Änderungen zum Pflichtenheft, bspw. gekürzte Wunschkriterien.
\item Vollständiges großformatiges Klassendiagramm im Anhang. \item Vollständiges großformatiges Klassendiagramm im Anhang.
Ausschnitte/Teile können bereits vorher verwendet werden, Ausschnitte/Teile können bereits vorher verwendet werden,
um Teilkomponenten zu beschreiben. um Teilkomponenten zu beschreiben.
...@@ -453,7 +453,7 @@ die helfen sollen einen Anfang zu finden. ...@@ -453,7 +453,7 @@ die helfen sollen einen Anfang zu finden.
\subsection{Bewertung eines Entwurfs} \subsection{Bewertung eines Entwurfs}
Hier ein paar Tipps, wie man einen Entwurf einschätzen kann. Hier ein paar Tipps, wie man einen Entwurf einschätzen kann.
Paradoxe Anforderungen zeigen, dass gutes Design ein Kunst ist. Paradoxe Anforderungen zeigen, dass gutes Design eine Kunst ist.
\begin{itemize} \begin{itemize}
\item Geheimnisprinzip (information hiding) beachtet? \item Geheimnisprinzip (information hiding) beachtet?
...@@ -499,7 +499,7 @@ Paradoxe Anforderungen zeigen, dass gutes Design ein Kunst ist. ...@@ -499,7 +499,7 @@ Paradoxe Anforderungen zeigen, dass gutes Design ein Kunst ist.
Observer, Visitor, Strategy Observer, Visitor, Strategy
\item Lokalitätsprinzip beachtet? \item Lokalitätsprinzip beachtet?
Eine Änderung der Spezifikation sollte nur lokale Änderungen benötigen. Eine Änderung der Spezifikation sollte nur lokale Änderungen benötigen.
Das Impliziert: Das impliziert:
Eine Klasse/Paket/Methode sollte für sich verständlich sein, Eine Klasse/Paket/Methode sollte für sich verständlich sein,
ohne dass Kontext notwendig ist. ohne dass Kontext notwendig ist.
\end{itemize} \end{itemize}
...@@ -537,12 +537,12 @@ Ein paar Beispiel, die in vergangenen PSE Projekten auftraten: ...@@ -537,12 +537,12 @@ Ein paar Beispiel, die in vergangenen PSE Projekten auftraten:
(Tipp: Alles in eine Datei und erst in der Implementierungsphase aufspalten) (Tipp: Alles in eine Datei und erst in der Implementierungsphase aufspalten)
\item \href{http://plantuml.sourceforge.net/}{PlantUML} noch ein Tool \item \href{http://plantuml.sourceforge.net/}{PlantUML} noch ein Tool
für Versions-Control-freundliche UML Diagramme. für Versions-Control-freundliche UML Diagramme.
Allerdings eigene Syntax, so dass keine Java code daraus erzeugt werden kann. Allerdings eigene Syntax, so dass kein Java-Code daraus erzeugt werden kann.
\item \href{http://www.objectaid.com/}{ObjectAid UML Explorer for Eclipse} \item \href{http://www.objectaid.com/}{ObjectAid UML Explorer for Eclipse}
ein Source-to-Diagram plugin. ein Source-to-Diagram plugin.
\item \href{http://www.eclipse.org/papyrus/}{Eclipse Papyrus} \item \href{http://www.eclipse.org/papyrus/}{Eclipse Papyrus}
\item \href{http://www.visual-paradigm.com}{Visual Paradigm} \item \href{http://www.visual-paradigm.com}{Visual Paradigm}
\item \href{http://argouml.tigris.org/}{ArgoUML} um auch Code zu generieren und beim Entwurf zu helfen (Vorsicht keine \enquote{Undo} Funktionalität) \item \href{http://argouml.tigris.org/}{ArgoUML} um auch Code zu generieren und beim Entwurf zu helfen (Vorsicht: keine \enquote{Undo}-Funktionalität)
\end{itemize} \end{itemize}
\subsection{Mehr Links} \subsection{Mehr Links}
...@@ -581,7 +581,7 @@ Ein paar Beispiel, die in vergangenen PSE Projekten auftraten: ...@@ -581,7 +581,7 @@ Ein paar Beispiel, die in vergangenen PSE Projekten auftraten:
also sollte man hier auch die meiste Zeit für aufwenden. also sollte man hier auch die meiste Zeit für aufwenden.
\item Einhaltung softwaretechnischer Prinzipien zeigen \item Einhaltung softwaretechnischer Prinzipien zeigen
(z.B. Kohäsion, Lokalitätsprinzip, etc) (z.B. Kohäsion, Lokalitätsprinzip, etc)
\item Gestrichene Wunschkriterien können aber müssen nicht erwähnt werden. \item Gestrichene Wunschkriterien können, aber müssen nicht erwähnt werden.
Man muss hier aufpassen, dass kein negativer Eindruck zurückbleibt. Man muss hier aufpassen, dass kein negativer Eindruck zurückbleibt.
Für manches gibt es gute Gründe, aber oft ist es geschickter Für manches gibt es gute Gründe, aber oft ist es geschickter
Streichungen nur im Dokument zu erwähnen. Streichungen nur im Dokument zu erwähnen.
...@@ -599,7 +599,7 @@ Ein paar Beispiel, die in vergangenen PSE Projekten auftraten: ...@@ -599,7 +599,7 @@ Ein paar Beispiel, die in vergangenen PSE Projekten auftraten:
\artefakt{Implementierungsplan zu Beginn, \artefakt{Implementierungsplan zu Beginn,
Implementierungsbericht als PDF Dokument Implementierungsbericht als PDF Dokument
und vollständiger Source Code} und vollständiger Sourcecode}
\subsection{Plan} \subsection{Plan}
...@@ -624,7 +624,7 @@ Ein paar Beispiel, die in vergangenen PSE Projekten auftraten: ...@@ -624,7 +624,7 @@ Ein paar Beispiel, die in vergangenen PSE Projekten auftraten:
beim Betreuer abzugeben. beim Betreuer abzugeben.
\end{itemize} \end{itemize}
\begin{figure}[bh] \begin{figure}[h]
\includegraphics[width=0.8\textwidth]{GANTT_example} \includegraphics[width=0.8\textwidth]{GANTT_example}
\caption{\label{fig:GANTT} \caption{\label{fig:GANTT}
Beispiel GANTT Chart: Beispiel GANTT Chart:
...@@ -644,7 +644,7 @@ Der kritische Pfad ist in rot gekennzeichnet.} ...@@ -644,7 +644,7 @@ Der kritische Pfad ist in rot gekennzeichnet.}
\item Welche Muss- und Wunschkriterien sind implementiert? \item Welche Muss- und Wunschkriterien sind implementiert?
\item Welche Verzögerungen gab es im Implementierungsplan? \item Welche Verzögerungen gab es im Implementierungsplan?
Kann beispielsweise als zweites GANTT Diagramm am Ende dargestellt werden. Kann beispielsweise als zweites GANTT Diagramm am Ende dargestellt werden.
\item Übersicht zu unit tests \item Übersicht zu Unittests
\end{itemize} \end{itemize}
\subsection{Unittests} \subsection{Unittests}
...@@ -794,9 +794,9 @@ Prüfungsunterlagen 5 Jahre lang aufzubewahren. ...@@ -794,9 +794,9 @@ Prüfungsunterlagen 5 Jahre lang aufzubewahren.
Da niemand so genau weiß, was das im Fall von PSE bedeutet, Da niemand so genau weiß, was das im Fall von PSE bedeutet,
wird am einfachsten \textsc{Alles} archiviert. wird am einfachsten \textsc{Alles} archiviert.
\begin{itemize} \begin{itemize}
\item Source-code (TeX,Java,Makefile,C++,Python,HTML,etc) \item Source-code (TeX,Java,Makefile,C++,Python,HTML,etc):
Vermutlich einfach der Inhalt eures Versionskontrollsystems. vermutlich einfach der Inhalt eures Versionskontrollsystems.
\item Artefakte (Compiliertes Programm, Dokumente, etc) \item Artefakte (Compiliertes Programm, Dokumente, etc).
Zwischenstufen (TeX .aux Dateien) kann man sich sparen, Zwischenstufen (TeX .aux Dateien) kann man sich sparen,
andererseits sind die auch nicht so groß. andererseits sind die auch nicht so groß.
\end{itemize} \end{itemize}
...@@ -919,7 +919,7 @@ indem beispielsweise jedes Teammitglied das Regelwerk unterschreibt. ...@@ -919,7 +919,7 @@ indem beispielsweise jedes Teammitglied das Regelwerk unterschreibt.
Häufigstes Problem ist, Häufigstes Problem ist,
dass ein oder mehrere Teammitglieder kaum mithelfen. dass ein oder mehrere Teammitglieder kaum mithelfen.
Die Aufgabenverteilung wird unfair Die Aufgabenverteilung wird unfair
und diejenigen die die Arbeit machen sind frustriert. und diejenigen, die die Arbeit machen, sind frustriert.
Wichtig ist als erstes Fakten zu sammeln und aufzuschreiben. Wichtig ist als erstes Fakten zu sammeln und aufzuschreiben.
Wer hat wann welche Aufgabe mit welcher Deadline zugeteilt bekommen? Wer hat wann welche Aufgabe mit welcher Deadline zugeteilt bekommen?
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment