Allgemeine Richtlinien eingefügt

README.md

@@ -111,15 +111,12 @@ Normalerweise sollten sie mit diesen Dateien auskommen. Sie können den Inhalt d
 Es ist normalerseise nicht notwendig weitere Dateien einzufügen, denn Dinge wie das Deckblatt, Eidesstattliche Erklärung, div. Verzeichnisse werden automatisch erstellt und gleich korrekt fomatiert.
 Hier nochmals eine Erklärung der verschiedenen Dateien:
 
-* Die `*.md` Dateien im Basisverzeichnis bilden den eigentlichen Inhalt Ihrer Diplomarbeit. Sie können diese Dateien mit jedem handelsüblichen Editor (zur Not auch direkt in Gitea) bearbeiten. Die Nummerierung am Anfang dient dazu, dass die Reihenfolge in der Diplomarbeit passt. So erscheint z.B: der Inhalt der Datei __20-zielsetzung.md__ nach __10-einleitung.md__ und vor __30*.md__. Die im Template angebotene Reihenfolge ist jene wie sie in der Diplomarbeit gewünscht ist.  
+* Die `*.md` Dateien im Basisverzeichnis bilden den eigentlichen Inhalt Ihrer Diplomarbeit. Sie können diese Dateien mit jedem handelsüblichen Editor (zur Not auch direkt in Gitea) bearbeiten. Die Nummerierung am Anfang dient dazu, dass die Reihenfolge in der Diplomarbeit passt. So erscheint z.B: der Inhalt der Datei __20-zielsetzung.md__ nach __10-einleitung.md__ und vor __30*.md__. Die im Template angebotene Reihenfolge ist jene wie sie in der Diplomarbeit gewünscht ist. Mit dieser Technik kann die Nummerierung der Dateinamen nicht mehr mit der Nummerierung der Abschnitte / Kapitel im Text übereinstimmen, aber das ist in Ordnung. Sie sollten sich im Allgemeinen auf die Namen / Bezeichnungen von Kapiteln / Abschnitten als Bezeichner verlassen und Pandoc selbst, LaTeX die eigentliche Abschnittsnummerierung übernehmen lassen. Die Nummern in den Dateinamen sind Dateinummern in einem für die Shell guten Format und so benutzerfreundlich wie möglich.
 * Das `/img` Verzeichnis beinhaltet alle Grafigen zur Diplomarbeit. Die können hier zur besseren Strukturierung auch gerne Unterverzeichnisse erstellen. Folgendes ist bei der Verwendung von Grafiken zu beachten:
     * Achten Sie darauf dass sie dort nur `*.jpg` und `*.png` Dateien ablegen 
     * Groß und Kleinschreibung müssen beachtet werden. So werden unter Linux die Datein `Hallo.jpg` und `hallo.jpg` als zwei unterschiedliche Dateien angesehen. Unter Windows hingegen nicht.
-    * Machen Sie Grafiken in guter Auflösung (> 72 dpi) und Achten Sie darauf dass diese nicht zu viel oder zu wenig Inhalt zeigen weil die Grafiken auf max. Seitenbreite skaliert werden können und dann entweder zu klein oder zu pixelig erscheinen.
-    * Orientieren sie die Grafiken so wie sie selbige in der Arbeit haben wollen. Wenn sie Grafiken um 90 Grad drehen, dann drehen Sie alle Grafiken in die selbe Reichtung !
 * Das `/pdfs` Verzeichnis beinhaltet Dateien welche im Appendix (auszugsweise oder ganz) eingefügt werden. Damit dies geschieht müssen sie aber im `metadata.yaml` korrekt referenziert werden. Es ist keine Schande hier viele Dateien abzulegen - sofern diese einen Bezug zur Diplomarbeit haben.
 
-
 ### Befüllen der speziellen Datein
 
 #### metadata.yaml
@@ -231,15 +228,76 @@ Jetzt kann es auch vorkommen, dass jemand anders ihnen zuvor gekommen ist, schon
 
 Bei speziellen Fragen zu diesem Vorgehen wenden Sie sich bitte an den Programmierlehrer Ihres Vertrauens. 
 
-
-
-
-
-
-
-
-
-
+## Tipps & Tricks
+
+### Generell
+* Man kan ToDo Blöcke in die DA einfügen indem man folgenden Block verwendet `\todo{Was noch zu tun wäre}`. Diese erscheinen dann als Textblasen am Rand der Arbeit.
+
+
+### Versionsverwaltung
+
+* Vor dem Schreiben: Neuesten Stand vom Server holen
+* Nach dem Schreiben: Sofort einchecken und zum Server übertragen
+* Verwenden Sie sinnvolle commit Kommentare (Nacrichten)
+* Verwalten Sie die DA und das Projekt in unterschiedlichen Repositories
+
+
+### Text
+
+* Grammatik + Rechtschreibung beachten (Markdown hat keinen Spell-checker integriert). ggf. `aspell` installieren und durch die Markdown files suchen lassen.
+* Irgendwie sollte man ein (einheitliches) Bild vom Leser haben. Negativbeispiel:
+    * Einerseits eine Dummy dem man `mdir` erklären muss
+    * andererseits kann er Python-Pakete installieren
+* Formulierungen
+    * keine romanartigen Erzählungen
+    * keine seitenlange Installationsanweisungen (besser: Link auf Anleitung im Web)
+
+
+### Quellcode
+
+* mit Java/Python/*-doc
+* Sinnvolle Namen verwenden
+* Coderichtlinien einhalten 
+    * definiert ?
+    * welche ?
+
+### Listings
+
+* Wenige (aber dafür aussagekräftige) Listings verwenden
+* am besten ohne Kommentare
+    * dafür mit Erklärung im Text darüber oder darunter
+    * mit Verweis auf File
+* UML Diagramme als Ergänzung
+
+### Bilder
+
+* Machen Sie Grafiken in guter Auflösung (> 72 dpi) und Achten Sie darauf dass diese nicht zu viel oder zu wenig Inhalt zeigen weil die Grafiken auf max. Seitenbreite skaliert werden können und dann entweder zu klein oder zu pixelig erscheinen.
+* Orientieren sie die Grafiken so wie sie selbige in der Arbeit haben wollen. Wenn sie Grafiken um 90 Grad drehen, dann drehen Sie alle Grafiken in die selbe Reichtung !
+* Quellenangaben nicht vergessen (bei selbst erstellen Bildern: 'Eigene Darstellung')
+
+### Quellenangaben
+
+* alle Tools inkl. Versionsnummer
+* alle Zitate bzw. übernommene Meinungen
+* Datenblätter usw. können auch zitiert werden-
+
+## Checkliste
+
+Abschließend noch eine kurze Liste der wichtigsten Punkte, an denen erfahrungsgemäßdie häufigsten Fehler auftreten. Diese Punkte bilden auch die Grundlage der routine-mäßigen Formbegutachtung an Universitäten.
+ 
+
+* Titelseite: Länge des Titels (Zeilenumbrüche), Name, Studiengang, Datum -> Ausbessern in metadata.yaml
+* Erklärung: vollständig mit Unterschrift.
+* Inhaltsverzeichnis: balancierte Struktur, Tiefe, Länge der Überschriften.
+* Kurzfassung/Abstract: präzise Zusammenfassung, passende Länge, gleiche Inhalte und Struktur.
+* Überschriften:Länge, Stil, Aussagekraft.
+* Typographie: sauberes Schriftbild, keine manuellen Abstände zwischen Absätzen oder Einrückungen, keine überlangen Zeilen, Hervorhebungen, Schriftgröße, Platzierung von Fußnoten.
+* Interpunktion: Binde- und Gedankenstriche richtig gesetzt, Abstände nach Punkten (v. a. nach Abkürzungen)
+* Abbildungen: Qualität der Grafiken und Bilder, Schriftgröße und -typ in Abbildungen, Platzierung von Abbildungen und Tabellen, Captions. Sind alle Abbildungen (und Tabellen) im Text referenziert?
+* Gleichungen/Formeln:mathem. Elemente auch im Fließtext richtig gesetzt, explizite Gleichungen richtig verwendet, Verwendung von mathem. Symbolen.
+* Quellenangaben:Zitate richtig referenziert, Seiten- oder Kapitelangaben bei gedruckten Medien
+* Literaturverzeichnis: mehrfach zitierte Quellen nur einmal angeführt, Art der Publikation muss in jedem Fall klar sein, konsistente Einträge, Online-Quellen(URLs) sauber angeführt inkl. letztem Betrachtungszeitpunkt
+* Sonstiges: ungültige Querverweise (??), Anhang, Papiergröße der PDF-Datei (A4=8.27×11.69Zoll), Druckgröße und -qualität.