Wie man eine super Anleitung erstellt

Es ist tausend mal besser irgendeine Anleitung zu haben, als überhaupt keine. Dies hier sind Richtlinien, keine Regeln. Selbst wir vergessen manchmal sie alle zu befolgen, oder ändern und schreiben sie, falls nötig, um. Wir wissen, dass irren menschlich ist. Diese Anleitungen werden mit der Zeit immer besser werden, mach dir also keine Sorgen, wenn nicht alles gleich perfekt ist. Sei ein Pionier!

Hervorragende Fotos sind das A un O, damit Leute auf deine Reparaturanleitung aufmerksam werden. Selbst mit einer günstigen Ausrüstung kannst du wirklich gute Fotos machen. Nimm dir einen Moment, um unsere Anleitungen zum Fotografieren anzusehen, bevor du mit dem Fotografieren anfängst.

Bilder und Text sollten sich gegenseitig ergänzen. Zusätzliche Fotos können Erläuterungen im Text ergänzen und umgekehrt.

Unbestimmte Ausdrücke wie "Ding", "Teil" und "Zeug" führen dazu, dass eine Anleitung nicht eindeutig ist. Wenn du die genaue Bezeichnung für etwas nicht kennst, dann versuche es über Google herauszufinden, oder indem du jemanden fragst. In einem Gerät gibt es mehrere komplexe Komponenten, eine Komponente mit "das Ding" zu bezeichnen ist nicht hilfreich!

Die Ausrichtung eines Gegenstandes sollte im Lauf der Anleitung so gut es geht die selbe bleiben. So ist es für den Leser leichter, sich bei seinem eigenen Gerät zurecht zu finden. Wenn du den Gegenstand drehst, dann mache eine entsprechende Angabe wie "Drehe das Gerät um" oder "Drehe das Gerät um 90° im Uhrzeigersinn", damit der Leser das gleiche tun kann.

Etwas Hintergrundinfo ist prima: warum du das hier machst, an wen sich die Anleitung wendet und was man braucht, um die Reparatur durchzuführen. Allerdings reicht das vollkommen aus, die meisten schaudern bei dem Gedanken daran, erst ein ganzes Buch lesen zu müssen, bevor sie mit der Reparatur anfangen können (wann hast du zum letzten Mal die Bedienungsanleitung deines Fernsehers durchgelesen?).

Links sind deine besten Freunde. Verlinke alles, was du kannst, zu relevanten Quellen anderswo auf der Website.

So sehr wir auch die Geschichten von deiner Urgrossmutter lieben, die Geschichte, wie sie einmal Eiscreme in ihre Handtasche gefüllt hat (ist bei meiner tatsächlich passiert!), sollte nicht mitten in einer Reparaturanleitung auftauchen. Für solche Geschichten gibt es geeignetere Stellen.

Es verleiht deiner Reparaturanleitung mehr Glaubwürdigkeit, wenn du stichhaltige Informationen hinzufügst.

Deine Reparaturanleitung wird nicht benutzt werden, wenn die Leute nicht verstehen, wovon du redest.

Es kann sehr verwirrend sein, wenn du Markierungszeichen nicht richtig benutzt. Nimm dir einen Moment Zeit und lies genau nach, was die einzelnen Markierungszeichen bedeuten. Benutze im Zweifelsfall die Standardeinstellung.

Wenn es sich um ein einfaches Gerät handelt, ist es nicht unbedingt nötig, zusätzliche Informationen für den Zusammenbau hinzuzufügen. Manchmal sind aber auch besondere Angaben zu beachten. Es ist zum Beispiel ziemlich einfach einen MacBook LCD Display auseinander zu bauen. Wenn du aber die Kabel beim Zusammenbau nicht richtig einlegst, dann reichen sie nicht bis zu ihren Verbindungspunkten auf dem Logic Board. Die Leser werden dir dankbar sein, wenn du eine dementsprechende Bemerkung machst, die ihnen beim Zusammenbau ihres in Einzelteile zerlegten Gerätes hilft.

Manchmal reichen Text und Bilder nicht aus. Ein oder zwei Diagramme (als Bild hochgeladen), helfen dem Leser genau zu verstehen, wie die Reparatur ausgeführt werden muss.

Ein Foto mit zu vielen Markierungen ist für den Leser nicht sehr einladend. Markiere falls überhaupt notwendig, nur so viel wie nötig ist, um genau zu zeigen, wovon du sprichst. Falls mehr als 4-5 Markierungen notwendig sind, dann solltest du diese Etappe in mehrere Schritte aufteilen. Schau dir im Zweifelsfall ein paar iFixit Reparaturanleitungen an.

Verwende nicht für jeden Schritt eine Überschrift. Wenn du grundständige Anleitungen richtig einsetzt, wird automatisch eine entsprechende Navigationsstruktur geschaffen, so dass Überschriften bei den einzelnen Schritten in den meisten Fällen nicht nötig sind.

Wir sind ein Team, und das sollte auch in deinen Anleitungen zum Ausdruck kommen. Dein Ton ist verbindlicher, wenn du Ausdrücke wie "ich habe dies oder das gemacht" in deinen Anleitungen vermeidest.

Wir sind hier um uns gegenseitig zu helfen, Sache zu reparieren. Behalte deine politischen Ansichten und andere Meinungen für dich, hier ist nicht die richtige Stelle dafür.

Gib direkte Anweisungen an den Nutzer. Vermeide die "es ist"-Falle, und benutze Verben, um auszudrücken, was du sagen willst.

Lade nur Fotos und Texte hoch, die dir gehören, oder auf die du Anrechte hast.