Wiki-Artikel Vorlage

Aus HSHL Mechatronik
Zur Navigation springen Zur Suche springen


Autor: Prof. Dr. Mirek Göbel

Einleitung

Dieser Artikel ist eine Vorlage für einen Wiki-Artikel. Tipp: Kopieren Sie den gesamten Quelltext und ändern Sie ihn so, dass er Ihr Projekt beschreibt.

Dieser Artikel ist aus der Kategorie "How-To".

Inhalt

Die Gliederung des Inhalts hängt stark von Ihrem individuellen Projekt ab. Benutzen Sie einen leicht nachvollziehbaren roten Faden und gliedern Sie nach gesundem Menschenverstand!

Statische Disziplin

Bei der statischen Disziplin geht es darum, dass Sie nachhaltig dokumentieren. Ein nachfolgender Studierender soll anhand Ihrer Projektunterlagen Ihr Projekt nachbauen und nachvollziehen können.

Hierzu gehört, dass Sie in SVN die nachfolgenden Unterlagen hinterlegen:

Konstruktionsplan im Lego Designer Liegt ein Bauplan in Lego Designer oder als kommentierte Fotostrecke vor?? Ist der Bauplan vollständig und korrekt? Bewertung der mechanischen konstruktion Einparkkonzept als Programm-Ablauf-Plan (PAP) Strategie der Geradeausfahrt/Spurführung Strategie der Lückenerkennung+Einparken/Kurvenfahrt Regelstrategie Implementierung des PAP in den entsprechenden Sprachen (Matlab, Simulink und/oder NXC) Wurden Formalien eingehalten (Header, Kommentare, Coding-Guidelines,...) Wurde modular programmiert? Umsetzung der Strategie der Geradeausfahrt/Spurführung Umsetzung der Lückenerkennung+Einparken/Kurvenfahrt Umsetzung der Regelstrategie Fahrzeugkennwerte Fahrzeuglänge in mm Fahrzeugbreite in mm Spurweite vorn in mm Spurweite hinten in mm Achsabstand in mm Max. Radeinschlagswinkel Linkseinschlag in Deg Max. Radeinschlagswinkel Rechtseinschlag in Deg Video als Beleg der Funktion Ihres Roboters. Beachten Sie die Hinweise. Beschreiben Sie Ihr Projekt als wissenschaftlichen Artikel im HSHL Wiki und verlinken Sie Ihre Dateien in SVN. Bewertet wird die Qualität Ihrer Projektdokumentation. Kriterien könnten sein:

Wurde eine Autorenseite im Wiki angelegt? Ist erkennbar, wer im Projektteam welche Leistung erbracht hat? Wurde plausibe erläutert, wieso diese Lösung (Matlab, Simulink oder NXC) gewählt wurde? Ist die Projektdokumentation vollständig? Qualität der Dokumentation


Unterabschnitt

  1. Nutzen Sie Aufzählungen
    • mit verschiedenen Schachtelungen
    • und so weiter
  2. zweite Ebene
    • mit erneuter Unterebene

Bilder

Bauen Sie Bilder ein, am besten mit darin gekennzeichneten Stellen, die Sie dann im Text erklären.

Beispielbild mit Quelle [1]

Tabellen

Eine tolle Tabelle ist hier dargestellt.

Spalte 1 Spalte 2 Spalte 3
blabla sowieso sowieso
test sowieso test1

Formatierung

Nutzen Sie zur Formatierung Beispiele, z. B. aus dem weltbekannten Wikipedia selbst (das ist die gleiche Syntax!) oder anderer Hilfeseiten wie z. B. [2].

Zusammenfassung

Was ist das Ergbnis? Das Ergebnis dieses Artikels ist eine Vorlage, mit der Nutzer des Wikis schnell und leicht eigene Artikel verwirklichen können. Diese Vorlage ist Bestandteil der Anleitungen aus den How-To's.


Ausblick

Was kann/muss noch verbessert werden?


Literaturverzeichnis