Leitfaden für Beitrage

Aus E34-Wiki
Version vom 6. Juli 2019, 13:19 Uhr von Admin (Diskussion | Beiträge) (Schützte „Leitfaden für Beitrage“ ([Bearbeiten=Nur Administratoren erlauben] (unbeschränkt) [Verschieben=Nur Administratoren erlauben] (unbeschränkt)))
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Wechseln zu: Navigation, Suche

Motivation

Ein kollaboratives E34-Wiki, indem jede Person etwas schreiben kann ist eine super Sache, jedoch benötigt dies, wie jede Art von soziale Umgebung auch ein paar Regeln und Richtlinien, damit sie funktioniert. Zum einen geht es natürlich um (hoffentlich) selbstverständliche Dinge, wie dem Respektvollen miteinander untereinander, dem Unterlassen von Beleidigungen, Rassismus und jeglicher anderer Form von Diskrimionierung in Diskussionen und in den Beiträgen selbst. Wir wollen eine offene Plattform bieten in der jeder etwas beitragen kann.

Zum anderen soll das Wiki für Leser konsistent und übersichtlich sein; die Bedienung einfach und intuitiv. Daher soll jeder Beitrag einem Schema folgen, welcher die Struktur bzw. den Aufbau des Beitrags vorgibt. Auf diese Weise "fühlt" sich jeder Beitrag ähnlich an und es wird eine konsistenz aufgebaut, da Leser beispielsweise schnell merken, dass sie am Ende jedes Beitrages den Abschnitt "Prüfung und Störungen" finden. Sucht man also nur diesen Abschnitt kann man intuitiv runterscrollen, egal um welches Bauteil es sich handelt.

Aufbau eines Beitrages

Ein Beitrag besteht aus mehreren Abschnitten. Jeder Abschnitt kümmert sich um einen Aspekt des zu beschreibenden Objektes. Jeder Abschnitt hat eine Überschrift, welche in der Größe "Ebene 2" formatiert sind.


Ein Beitrag besteht aus folgenden Abschnitten:


Überschrift (Diese wird automatisch vom Wiki erstellt)

- Unter der Überschrift wird das zu beschreibende Objekt kurz erklärt und eingeleitet. Dieser Abschnitt sollte maximal 10 Sätze betragen.


Funktion

Unter dem Abschnitt Funktion wird... ja eben die Funktion erklärt. Was tut das zu beschreibende Objekt? Welchen Zweck erfüllt es (und eventuell, warum man es benötigt)? Hier darf gerne auch darauf eingegangen werden, wie das Objekt diese Funktion erfüllt, sprich die Funktionsweise.


Einbauort

In diesem Abschnitt wird der Einbauort im Auto beschrieben. Am besten geschieht dies mithilfe von zusätzlichen Bildern. Aus dem Text und Bildern soll ersichtlich werden, wo das Bauteil sich befindet, sodass man es selber am eigenen Wagen lokalisieren kann. Bei kleinen oder schwer zu findenden Bauteilen sollten die Bilder Schrittweise das Bauteil annähern, sprich das erste Bild sollte grob die Umgebung des Bauteils zeigen, das nächste dann eventuell eine Nahaufnahme. Auf den Bildern darf gerne Text oder Pfeile eingezeichnet werden. Bei Bauteilen/Objekten die sich nicht im/am Auto befinden sollte dieser Abschnitt der Vollstädnigkeit halber trotzdem vorhanden sein, auf den Umstand kann ja ironischerweise hingewiesen werden (Beispiel: Funkfernbedienung). In diesem Abschnitt wird noch nicht auf Ausbau des Objektes eingegangen.


Eigene Abschnitte

Nach dem Abschnitt für den Einbauort dürfen eigene Abschnitte hinzugefügt werden, die bestimmte Umstände des Bauteils näher erläutern. Dies können wichtige Aspekte, Zusatzinformationen, weitere Funktionen oder ähnliches sein.


Teilenummern

Hier werden alle Teilenummern aufgelistet, die das Bauteil betreffen. Nach Möglichkeit sollen hier alle Teilenummern gelistet werden, die das Bauteil im Laufe seiner Herstellungszeit besessen hat. Auch notwendige zusatzteile für das Bauteil sollen hier gelistet werden, wie zum Beispiel Dichtungen, spezielle Schrauben oder Ähnliches. Existieren keine Teilenummern zu dem Bauteil, da nicht bekannt oder da man es nie bestellen konnte, kann dieser Abschnitt weggelassen werden.


Schaltbild und Anschluss

Unter diesem Abschnitt sollen Schaltbilder und Art und Weise des elektronische Anschluss beschrieben werden. "Elektronischer Anschluss" bedeutet hierbei elektronische Kenndaten wie Spannung, Leistungsaufnahme, Polarität der Anschlüsse, notwendige Sicherungen, etc... Schaltbilder dürfen gerne auch selbst angefertigt werden, solange sie Verständlich und korrekt sind.

Handelt es sich bei dem Bauteil nicht um ein elektronisches Teil oder sind keine Daten für diesen Abschnitt bekannt, kann er weggelassen werden.


Prüfung und Störungen

Dieser Abschnitt behandelt Probleme mit dem Bauteil. Der Abschnitt wird in 3 Überschriften unterteilt:

Prüfung

Unter dieser Überschrift wird erklärt, wie das Bauteil auf seine korrekte Funktionstüchtigkeit zu prüfen ist. Hierbei darf gerne eine Schritt-für-Schritt Anleitung beschrieben werden, die immer mehr Fehlerquellen ausschließt. In dieser Anleitung darf auch beschrieben werden, wie die Fehlerquelle zu reparieren ist, am besten durch Verlinkung auf den Wiki-Eintrag, falls es sich um ein weiteres Bauteil handelt. (Exemplarisch möchten wir hier auf die Prüfungsanleitung des Bauteils Innenraumbeleuchtung verweisen. Diese Anleitung dient als Musterbeispiel.)

Typische Ursache einer Störung

Unter dieser Überschrift wird aufgelistet, welches die typischen Ursachen einer Störung des Bauteils sind. Wenn die Ursachen bei Defekten anderer Bauteile liegen, sollten die Wiki-Einträge dieser hier auch markiert werden.

Typische Auswirkungen einer Störung

Unter dieser Überschrift werden typische Symptome aufgelistet, die eintreten, wenn das Bauteil defekt oder beschädigt ist.


Umgang mit Verlinkungen

Werden in einem Beitrag andere Bauteile erwähnt, sollten diese generell verlinkt werden. Dabei ist es irrelevant, ob ein Beitrag über das genannte Bauteil schon exisitiert oder nicht. Verlinkungen die noch ins Leere führen, können nämlich auch dabei helfen weitere Bauteile ins Wiki aufzunehmen.

Verlinkungen auf externe Seiten sollen generell vermieden werden! Falls ein Beitrag jedoch einen "Quellen"-Abschnitt besitzt, dürfen externe Verlinkungen als Quellenangabe verwendet werden.

Beispiel

Exemplarisch für den oben beschriebenen Aufbau dient der Beitrag Funkfernbedienung, indem der Aufbau korrekt befolgt wurde.