Leitfaden für Beitrage: Unterschied zwischen den Versionen

Aus E34-Wiki
Wechseln zu: Navigation, Suche
Zeile 40: Zeile 40:
  
 
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.
 
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''
 
''Typische Ursache einer Störung''

Version vom 6. März 2019, 21:11 Uhr

Motivation

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.


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.

Beispiel

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