diff --git a/general/bibliography.bib b/general/bibliography.bib index 8cffca1..ee737fd 100644 --- a/general/bibliography.bib +++ b/general/bibliography.bib @@ -115,4 +115,20 @@ month = {Dec}, note = {[Online; accessed 12. Dec. 2018]}, url = {https://de.wikipedia.org/wiki/Freie_Software} +} +@misc{draw, + author = {Atlasian} + title = {{draw.io - free flowchart maker and diagrams online}}, + year = {2018}, + month = {Dec}, + note = {[Online; accessed 12. Dec. 2018]}, + url = {https://www.draw.io} +} +@misc{apache, + author = {{Apache Software Foundation}} + title = {{Apache License, Version 2.0}}, + year = {2018}, + month = {Oct}, + note = {[Online; accessed 12. Dec. 2018]}, + url = {https://www.apache.org/licenses/LICENSE-2.0} } \ No newline at end of file diff --git a/projekthandbuch/projekthandbuch.org b/projekthandbuch/projekthandbuch.org index e740cb1..40e47bc 100644 --- a/projekthandbuch/projekthandbuch.org +++ b/projekthandbuch/projekthandbuch.org @@ -249,27 +249,67 @@ PLACEHOLDER PLACEHOLDER -*** TODO Versionskontrolle +*** Versionskontrolle + +Eine Versionskontrollsoftware ist in der Software Entwicklung heutzutage +praktisch nicht mehr wegzudenken. So wurde auch bei diesem Projekt eine +eingesetzt. + +Als Software für die Versionskontrolle wurde Git footcite:git aus folgenden +Gründen ausgewählt: + +- Ist der de facto Standard bei Versionskontrollsoftware +- Läuft auf allen gängigen Betriebssystemen +- Es gäbe gratis Services die man nutzen könnte (Github, Gitlab) +- Man kann offline arbeiten und Commits erstellen +- Der Author hat bereits einen eigenen Git Server zur Verfügung +- Der Author ist bereits mit Git aus vorhergehenden Projekten vertraut, + dadurch muss man keine Ressourcen aufwenden eine neue Software zu lernen. + Zusätzlich hat sich Git in den vorhergehenden Projekten als robuste + und schnelle Software erwiesen. +- Git ist gls:libre unter der gls:gpl v2. + +*** Editor + +Sowohl bei der Dokumentation wie auch bei der Programmierung wurde +hauptsächlich der Editor GNU Emacsfootcite:emacs verwendet. GNU Emacs ist mit +32 Jahren (obwohl seine Wurzeln bis ins Jahre 1976 zurückgehen) wohl eines der +ältesten noch "aktiven" Software Projekte. Emacs ist gls:libre unter der +gls:gpl v3. Emacs wurde gewählt da es ein schneller, schlanker und sehr +flexibler Texteditior ist. Von normaler Textmanipulation über Taskmanagement +und Emails schreiben ist alles möglich. + +*** Dokumentation + +Diese Dokumentation wurde in Org-mode footcite:orgmode, einer Erweiterung für +den Text Editor Emacs, geschrieben. Die Syntax erinnert an Markdown und +Org-mode bietet einem eine vielzahl an Hilfen dafür inklusive dem erstellen von +Tabellen und Spreadsheet Funktionen. Für finalle Version des Dokuments kann +Org-mode die ursprünglich Textdatei über LaTeX in ein PDF exportieren. + +LaTeX footcite:latex ist eine Software, welche einem die Benutzung des +Textsatzsystems TeXs vereinfacht. LaTeX wurde gegenüber einem "What You See Is +What You Get" (z.Bsp. MS. Word), Editor gewählt weil es einem mit seiner Markup +Sprache erlaubt das Dokument in Text Dateien zu erstellen, gerade für +Programmiere ist dies eine sehr interessante Lösung. Dadurch, dass LaTeX auch +nur aus reinen Textdateien besteht, kann man die Dokumente auch ohne weiteres +in die Versionskontrollsoftware einchecken und die Entwicklung im Log +zurückverfolgen. LaTeX ist gls:libre unter der LaTeX Project Public +License. + +Die Grafiken in diesem Dokument wurden hauptsächlich mit dem Vektor Grafik +Editor Inkscape footcite:inkscape erstellt. Inkscape ist gls:libre unter der +GNU Public License v3. + +Die Diagramme wurden mit Draw.io footcite:draw erstellt. Draw.io ist gls:libre +unter Apache Lizenz Version 2.0 footcite:apache und kann sowohl als Desktop +Applikation wie auch als Webanwendung genutzt werden. + +** TODO User Stories PLACEHOLDER -*** TODO Entwicklungsumgebung - -PLACEHOLDER - -*** TODO Editor - -PLACEHOLDER - -*** TODO Dokumentation - -PLACEHOLDER - -*** TODO User Stories - -PLACEHOLDER - -*** TODO Use Cases +** TODO Use Cases PLACEHOLDER