Leitfaden für neue Artikel

Aus mmp-netzwissen
Wechseln zu: Navigation, Suche

Dieses Dokument beschreibt die formalen Vorgaben, welche beim Erstellen eines Wiki-Eintrags im Modul “Interaktive Medien” eingehalten werden müssen.

Aufbau eines Artikels

Jeder Eintrag hat folgenden Aufbau vorzuweisen:

Titel

  • So kurz und aussagekräftig wie möglich, selbsterklärend.
  • Keine Abkürzungen, ausser allgemein bekannte Begriffe (z.B. HTML, CSS).
  • Gutes Beispiel:
    • Suchmaschinen-Optimierung mittels HTML-Tags
  • Schlechte Beispiele:
    • Spiel der Sprachen -> sagt nichts aus
    • LESS -> die meisten Erstsemestrigen wissen nicht, was LESS ist
    • Hinweise, Tipps und Tricks für IoT-Projekte mit dem Intel-XDK -> zu lange

Kurze Definition / Beschreibung des Themas

  • Kurz in 2-3 Sätzen das Thema des Eintrags beschreiben. Die wichtigsten Begriffe erklären (z.B. was sind semantische HTML-Tags? Was ist LESS?).
  • Falls Begriffserklärungen den Rahmen sprengen, wenn möglich auf Einträge im Original-Wikipedia verlinken, z.B. auf “Content Management System”.

Eingangskompetenzen

  • Kurze Beschreibung der Vorkenntnisse, welche für das Verständnis des Eintrags erforderlich sind. Ist in einer Auflistung zu verfassen:
  • Beispiel:
    • Grundlegende HTML- und CSS-Kenntnisse
    • Einfachste Javascript-Kenntnisse

Lernziele

  • Kurze, spezifische, messbare Beschreibung dessen, was der Leser nach dem Durchlesen des Artikels wissen muss. Ist ebenfalls in einer Auflistung gemäss SMART zu verfassen:
  • Beispiel:
    • Die Studenten wissen, welche HTML-Tags zur Suchmaschinenoptimierung geeignet sind.
    • Die Studenten verstehen den Zusammenhang zwischen CSS, HTML und PHP.
    • Die Studenten wenden Bootstrap-Formulare erfolgreich an.

Inhaltsverzeichnis

  • Nicht mehr als 2 Stufen, nach der Vorlage:
1. Übertitel
1.1 Untertitel (es darf also kein 1.1.1 geben)
  • Vorgaben gemäss Titel (aussagekräftig, kurz usw.)

Beitragsbild

  • Wenn möglich ein Beitragsbild (oben rechts) einfügen.
  • Kurze Bildunterschrift.
  • Nur dort, wo es auch Sinn macht.

Inhalt

  • Der eigentliche Inhalt des Beitrags.
  • Wording einhalten!
  • Eine gute und übersichtliche Struktur (Absätze, verschiedene Blöcke usw.) einhalten.
  • Die Strukturierung des Inhalts ist komplett frei. Es sollte einfach auf die Übersichtlichkeit geachtet werden.

Fragen zur Lernkontrolle

  • Fragen, wie sie an einer Prüfung bezüglich des Artikels gestellt werden können.
  • Ist in einer Auflistung zu verfassen.
  • Mindestens zwei Fragen, maximal fünf.
  • Beispiele:
    • Welche Vorteile bietet Typo3 gegenüber Wordpress? (Zum Thema Vor- und Nachteile der gängigsten CMS)
    • Was ist der Unterschied zwischen einer Klasse und einer ID in CSS? (Zum Thema CSS).

Weiterführende Links

  • Link können direkt im Text eingebunden werden mit [<url> <linkname>]
  • Angabe weiterführender Themen / Links, ist als Auflistung zu verfassen.
  • Hierarchie: Zuerst die MMP-Wiki-internen Links, dann die externen (z.B. Original-Wikipedia)

Wording

Folgende Regeln sind beim Erfassen der Artikel einzuhalten:

Unpersönliche Form

Die Texte sind in unpersönlicher Form zu verfassen. Ausdrücke wie “ich denke…” oder “du sollst...” sind zu vermeiden, ebenfalls Formulierungen wie “die Autoren denken…” oder “die Studenten sollen…”. Bei Unklarheiten wissenschaftliche Texte als Stilvorlage heranziehen. Ausgenommen von dieser Regel sind die Lernziele.

Kurze, verständliche Sätze

Die Sätze müssen kurz und verständlich sein. Nicht bekannte Begriffe sollten erklärt oder mit weiterführenden Links versehen werden.

Videos

Videos sind auf Youtube unter dem Channel htwnetzwissen hochzuladen und im Beitrag zu verlinken:

User: htwnetzwissen@gmail.com
Passwort: Netzwissen2016

Wichtig: Bei Videos braucht es einen Vor- und Abspann. Der Abspann muss Credits auf verwendete Bilder, Musik etc. und das HTW-, resp. BFH-Logo enthalten.

Bilder

Bildunterschrift

Bilder müssen eine passende Bildunterschrift aufweisen.

Grösse

Bilder sollen für das Web optimiert sein und eine Grösse von höchstens zwei Megabyte aufweisen.

Weiterführende Links