Wiki-Artikel schreiben

Zielsetzung der Artikel

Das Ziel ist die nachhaltige Sicherung von Informationen. D. h. die Artikel sollen so geschrieben sein, dass jemand die Erkenntnisse leicht verwenden kann und z. B. realisierte Projekte nachbauen kann! Es gilt: „Inhalt vor Schönheit“ bei Einhaltung des wissenschaftlichen Standards für Dokumentationen.

Aufbau der Artikel

Sie dürfen die Vorlage für Wiki-Artikel Wiki-Artikel_Vorlage als Grundlage verwenden. Der Aufbau ist wie folgt:

1. Einleitung
   • inkl. Nennung der Autoren
   • Beschreibung des organisatorischen Rahmens (Praktikum? Lehrveranstaltung?), in dem dieser Artikel entsteht.
   • Fügen Sie einen Link ein, der zu dem organisatorischen Rahmen des Projekts zurückführt (z. B. zu einer Übersichtsseite einer Lehrveranstaltung)
2. Inhalt, gegliedert je nach Sinn & Zweck
   • Arbeiten Sie Ihre wesentlichen Erkenntnis bei Ihrem Projekt heraus. Was haben Sie gelernt?
   • Schritt-für-Schritt-Anleitungen (Quellcode, Bilder, Problemlösungen, Kochrezepte,…)
   • Details wie
     • Bill of Material (BOM)
     • ggf. Programmablaufpläne
     • z. B. bei Regler-Themen: Herleitung der verwendeten Regelstrecke und des Reglers
     • z. B. Bei Sensor-Themen: Berechnung der Güte der Sensoren nach den bekannten Methoden der Messtechnik
3. Fazit/Zusammenfassung/Ausblick
   • Was ist das Ergbnis?
   • Was kann/muss noch verbessert werden?
   • Fügen Sie einen Link ein, der zu dem organisatorischen Rahmen des Projekts zurückführt (z. B. zu einer Übersichtsseite einer Lehrveranstaltung)
4. Quellen: Sobald Sie eine Quelle (insbesondere bei Bildern) verwenden, nennen Sie diese.
5. Korrektur/Rückmeldungen

Regeln für das Verfassen von Artikeln

Bitte beachten Sie beim Verfassen von Artikeln in diesem Wiki unbedingt die folgenden Hinweise! Tipp: Nach Verfassen des Artikels kontrollieren Sie noch einmal diesen und nutzen die folgende Liste als "Checkliste".

1. Ganz zu Beginn und am Ende des Artikels ist ein Link auf die Seite zu erstellen, der diesen Artikel auflistet, um dort wieder leicht zurück zu kommen.
2. Bilder:
   • Auf Bilder im Text verweisen, Bilder dazu klar kennzeichnen, z.B. Abb. 1.
   • Bei jedem Bild ist eine aussagekräftige Bildbeschriftung mit dem SVN-Link auf die Quelldatei zu erstellen!
   • Nutzen Sie die Bilder ausführlich für Erklärungen, z. B. indem Sie mit Hilfe von Ziffern o. ä. Markierungen im Bild verwenden!
   • Platzieren Sie Ihre Bilder übersichtlich und in einer ansprechenden Größe
3. Tabellen
   • Tabellen als echte Wiki-Tabelen anlegen, nicht als Bild
   • Siehe Wiki-Artikel_Vorlage
4. Nutzen Sie Verknüpfungen (insbes. zu internen Artikeln) und helfen Sie mit diese zu verbessern, indem Sie die für Ihren Artikel notwendigen Infos dort mit einbringen.
5. Quelltext
   • Quelltext in einer Zeile mit x + y = 5 einbinden
   • Quelltext-Möglichkeiten nutzen, siehe Quelltext_einbinden
6. Quellen
   • Immer angeben (insbesondere bei Bildern etc.), und zwar unbedingt so mit einer Fußnote
   • Auf die Bildrechte achten, d.h. nur eigene Bilder zeigen oder solche, die Sie auch verwenden (und damit veröffentlichen) dürfen.
7. Nutzen Sie Aufzählungen/Tabellen/Formeln, um Ihren Text leicht lesbar zu machen.
8. Vermeiden Sie langen Fließtext.
9. Beschreiben Sie alles so, dass jemand mit Ihren Erkenntnissen das Projekt aufgreifen, erweitern, modifizieren, benutzen etc. kann.
10. Schreiben Sie den Artikel wie eine wissenschaftliche Arbeit. Hilfreich dazu ist dieses Buch . Auch empfiehlt sich der Blick ein beispielhafte wissenschaftliche Arbeiten, z. B.: Datei:Skript Fahrwerkmanagent ProfGöbel.pdf
11. Hängen Sie alle notwendigen Daten zum "Nachbau" Ihres Fachthemas als zip-Datei an Ihren Wiki-Artikel.
12. Rechtschreibung! Prüfen Sie Ihren Artikel sorgfältig (ggf. mit Hilfe einer Textverarbeitungs-Software)
13. Fügen Sie Ihrem Artikel eine zip-Datei mit allen wichtigen Dateien zum Nachbau Ihres Projekts hinzu:
    • Präsentation (.ppt und .pdf)
    • Für Lego Roboter - Anleitung zum Nachbau (Lego Designer .ldx und .html)
    • ggf. Platinenlayout, Schaltungssimulation, Circuit-Cam, Boardmaster-Originaldateien
    • ggf. Software/Implementierung
14. Formeln:
    • Korrekte Multiplikationspunkte verwenden! $A \cdot B$
    • Anleitung zum Verfassen von Formeln siehe auch Wissenschaftlich_Arbeiten_mit_LaTeX

Beispiele

Tabellen

Tabelle 1: Inhalt des HSHL-Mechatronik-Baukasten

Pos.	Anz.	Beschreibung	Link		Pos.	Anz.	Beschreibung	Link
①	1	Funduino Sortierkoffer	03-212		⑱	100	LEDs (je 20* 5 mm)<br Rot, Gelb, Grün, Blau, Weiß	R20-F-1-1
②	1	Funduino Arduino UNO R3	R20-A-3-1		⑲	40	Jumper Kabel, männlich/männlich, 20 cm	R19-F-2-2

Tabelle 2: Tabellenzellen einfärben

Pin	Farbe		Funktion
1		Schwarz	GND
2		Orange	Phase A
3		Weiß	Phase B
4		Grün	Phase C
5		Blau	NC
6		Rot	NC

Ausblendungen

Lösung  

int LED = 9;   // <- Zahl = 9, weil das Kabel mit Digital 9 verbunden ist.
void setup()         
{                    
//später
}
void loop() 
{ 
//später
}

How To

Animated GIF

1. Wandeln Sie das Video mit dem Online Tool img2go in ein animiertes GIF.
2. Laden Sie die Datei hoch.
3. Binden Sie diese wie ein Bild ein.

Abb. 1: Beispiel für ein animiertes GIF

FAQ

1. Wie kann ich einen Artikel anlegen?

Geben Sie den Titel in das Suchfeld ein, drücken Sie die Lupe (Suchen) und drücken Sie anschließend auf den Link
Erstelle die Seite „NeueSeite“ in diesem Wiki.

Weiterführende Links

• Wiki: Syntax und Befehle
• Hilfe:Textformatierung

Literatur

→ zurück zum Hauptartikel: Praktikum SDE