Gut, ich steige ganz direkt ein: Ich habe mir eben Programmier-Anleitungen eines Freundes angesehen und mich so sehr beömmelt wie schon lange nicht mehr. Mir wäre die Zeit zu schade, es ihm direkt Punkt für Punkt zu erklären, also werde ich es aufschreiben. Und natürlich kann sich das so auch jeder andere ansehen und so vielleicht auch etwas davon lernen. Oder mich dafür kritisieren, dass ich hier totalen Scheiß vermittle.
Zuerst sollte man sicherstellen, ob überhaupt eine schriftliche Anleitung Sinn macht. In vielen Fällen ist ein Video oder ein praktisches Vormachen viel sinnvoller. In manchen Fällen ist es auch schlauer, sein Wissen vorerst für sich zu behalten.
Als nächstes sollte man sich klar machen, welche Rahmenbedingungen gelten. Dies sind all die Metafragen, die an sich erstmal wenig mit der eigentlichen Thematik zu tun haben. Mögliche Aspekte sind:
Man sollte also zum Beispiel an die Zielgruppe denken. Es macht nur wenig Sinn, einen derart professionellen Artikel für Schüler oder den sehr kleinen Freundeskreis zu schreiben, womit dieser Text natürlich einem ironischen Negativbeispiel dienen soll.
Mehr Strukturelemente (Überschriften, Aufzählungszeichen, explizite Verweise etc. pp.) alleine bewirken nicht, dass der Inhalt besser verstanden wird. Auch sollte der Zeitaufwand beim Schreiben und Lesen in Betracht gezogen werden.
Es wird zwar bei Schulreferaten eher seltener vorkommen, dass Betriebsgeheimnisse ausgeplaudert werden, aber man sollte sich generell Gedanken machen, ob gewisse Details dem Publikum vorenthalten werden sollten. Nicht nur aus Datenschutzgründen, sondern auch, da zu viele Konkretisierungen vom Thema ablenken können.
Natürlich sollte man das Medium wählen, das sowohl bei der Erstellung praktikabel ist, wie aber auch gut vom Leser genutzt werden kann. Für mich ist das Mittel der Wahl HTML, dicht gefolgt von Textverarbeitungs-Anwendungen wie Microsoft Office oder OpenOffice.
Als erstes wird lässig drauf los-geschrieben, ohne lange nachzudenken. Dies ist wichtig, um eine gewisse Spritzigkeit herausscheinen zu lassen. Überlegt man zu lange, wie man zum Beispiel etwas formulieren sollte, liest sich in der Regel auch der Text langsamer. Nicht mehr beim Schreiben nachdenken, als der Leser beim Lesen mitdenken kann!
Hat man sich erstmal für einen Titel entschieden, sollte man sich auch an das Vokabular halten. Ein verbreiteter Anfängerfehler ist es, den Titel beim weiteren Schreiben außer Acht zu lassen und somit nicht mehr das zu liefern, für das der Leser eigentlich eingestiegen ist. Dies kann das gesamte Werk praktisch kaputtmachen. Titel sollten interessant sein, kleine Wortspiele sind in Ordnung, sollten aber nicht übertrieben werden.
Auch, wenn es in vielen Situationen offensichtlich ist, sollte man immer seine Werke mit gewissen Metainformationen versehen. Neben Daten wie Datum und Namen könnte man aber auch einfach erklären, warum man überhaupt diesen Text schreibt. Diese Herangehensweise finde ich persönlich viel besser, als sich nur auf objektive Daten zu beschränken. Eine subjektiv ansprechende Einleitung soll den vielleicht etwas gelangweilten Leser dazu motivieren, einen bei der Reise zu begleiten.
Natürlich kann man nicht vollständig jeden einzelnen möglichen Aspekt abstecken, aber man sollte schon grob in Aussicht stellen, warum es sich lohnen könnte, diesen Text zu lesen. Da der Leser für gewöhnlich nicht viel dümmer ist als der Schreiber, kann er sich schon anhand weniger Beispiele denken, wohin sich das Prinzip sonst noch übertragen ließe.
Eigentlich fast das gleiche sind die Anwendungsfälle, also die möglichen Situationen, in denen man die in der vorliegenden Anleitung beschriebenen Vorgänge gebrauchen könnte. Die genaue Gliederung kann man sich komplett selbst ausdenken. Niemand würde einen dafür kritisieren, die Anwendungsfälle anders zu betiteln oder anders einzugliedern.
Schritt für Schritt wird erklärt, was zu tun ist. Die Schritte sollten möglichst grob formuliert werden und durch Überschriften die Orientierung im Text erleichtern. Die Überschriften helfen natürlich auch diejenigen, die schon ein gewisses Wissen zum Thema haben und nach bestimmteren Daten suchen. Man kann die einzelnen Punkte immer auch nummerieren, nur muss man dabei darauf achten, dass dies den Streberfaktor deutlich anheben kann, was wiederum einen Teil der Leserschaft abschreckt, weiter zu lesen. Andererseits kann eine Nummerierung Sinn machen, wenn man besonders viele Punkte hat, die sich teilweise ähneln. So kann innerhalb des Werkes oder auch bei externen Bezugnahmen gut differenziert werden. Natürlich muss die Zielgruppe aber auch mit den genutzten Zahlen umgehen können. Römische Zahlen sollte man nur bedingt verwenden.
Manche Dinge lassen sich nicht gut im Ablauf einordnen. Diese kann man gern in einen eigenen Abschnitt schreiben, den ich hinter dem Ablauf ansiedeln würde, da diese Zusatztipps in der Regel weniger wichtig sind als der eigentliche Ablauf.
Nach der Ablaufbeschreibung sollte der vorgesehene ist-Zustand beschrieben werden und dabei auch gern Bezug auf die vorher angekündigten Ziele genommen werden. Arbeitsschritte sollten jedoch nicht wiederholt werden, um Informationen an jeweils einem Ort zu behalten.
Auch dieser Punkt ließe sich eben so gut zum vorherigen dazuzählen. Ich finde es aber ganz nett, ihn zu separieren.
Völlig unabhängig von den bisher genannten Aspekten würde ich noch folgendes beachten:
Nun sollten wir eine Anleitung vor uns liegen haben, die sowohl dem Leser den Vorgang oder das Prinzip vermittelt, wie aber auch eine gute bis sehr gute Note erzielen kann, solange denn auch der Arsch in der Hose gegeben ist, das Werk so wie es ist abzugeben — Und dann auch dazu zu stehen, dass das Wort "Arsch" darin vorkommt. Als ob das jemanden wirklich stören würde.
Und natürlich darf man auch später noch einen Absatz hinzufügen, wenn ein relevanter Aspekt vergessen wurde.
Das Schreiben einer guten Anleitung ist garnicht so schwer. Im Grunde braucht man auch keine genauen Vorgaben einhalten, sondern nur mit gesundem Menschenverstand das aufschreiben, das man für wissenswert und interessant hält. Ich hoffe, dass dieser Text weiterhelfen konnte.