Computer Hardware Forum - TweakPC - "Tutorials schreiben leicht gemacht" - kleiner Leitfaden zum Erstellen von Tutorials

[size=5][b]"Tutorials schreiben leicht gemacht"[/b][/size]
[B][SIZE="3"]- Ein kleiner Leitfaden zum Erstellen von Tutorials -[/SIZE][/B]

Tutorials schreiben leicht gemacht.
Hilfreiche Tipps und Ratschläge, um ein Tutorial leicht lesbar und übersichtlich zu gestalten.

[size=4][b]Abstract / Vorwort[/b][/size]

Liebes Forenmitglied,

in unserem Foren tauchen Tag für Tag immer neue Themen zu immer komplexeren Themengebieten auf. Unsere aktiven Mitglieder bemühen sich redlich, diese Problemstellungen zu bewältigen. Hin und wieder kommt es sogar vor, dass solch ein geballtes Wissen "in Stein" gegossen wird und ein Tutorial bzw. eine längere Anleitung entsteht.

Allerdings tauchen auch hin und wieder "Tutorials" auf, welche jedweder Struktur, Menge und Inhalt entbehren. Um eine qualitative Verbesserung in dieser Tutorial & Erfahrungsberichte Sektion zu erreichen, möchte ich mit dieser Anleitung jedem potentiellen Schreiberling einen Leitfaden zum Erstellen von Tutorials und Erfahrungsberichten in die Hand geben.

Dabei werde ich die Bereiche Layout, Struktur und Inhalt ansprechen. Anschließend seien noch einige positive Beispiele genannt, welche lange vor diesem Tutorial entstanden sind und als Anschauungsmaterial dienen sollen.
Als Abschluss gebe ich noch ein paar Tipps, welche anderen Gegebenheiten hier im Forum beachtet werden sollten, um ein neues Tutorial bestmöglich zu positionieren.

[size=4][b]Inhalt[/b][/size][LIST=1][*]Layout (welche Schritarten und -größen?, wohin mit den Bildern?, Bilder als Thumbnail oder doch in voller Pracht?)[*]Struktur (Welche Kapitel?, Wo fange ich mit der Anleitung an?, Welche Grundlagen sollten erörtert werden? Woher habe ich mein Wissen bezogen?)[*]Inhalt (Mindestmenge, Schreibstil sowie Vermutungen)[*]Positive Beispiele[*]Spezielle Hinweise für Tutorials/Erfahrungsberichte im TweakPC.de Forum (extra Diskussionthread, moderativer Eingriff, Zusätzliches von anderen Benutzern, Auflistung in der Kategorienliste/Übersicht)[*]Nützliche Programme / Weiterführende Links[*]Anhang: [post=491059]Checkliste für Tutorials/Erfahrungsberichte zum schnellen überfliegen[/post][/LIST]

[size=4][b]1. Layout[/b][/size]

Das Layout ist der erste Eindruck eines Tutorials bzw. eines Erfahrungsberichtes. An ihm sieht ein Leser schnell die investierte Arbeit und die Liebe, die der Autor in den Text investiert hat. Möchtest du also ein wirklich gutes Tutorial bzw. einen wirklich guten Erfahrungsbericht schreiben, solltest du das Layout sehr übersichtlich gestalten.

[b][size=3]1.1 Keine anderen Schriftarten! Keine anderen Farben![/size][/b]

Nichts ist nerviger als eine [font=Times New Roman]aufgezwungene Schriftart[/font]. Nichts toppt das ganze dann auch noch, als eine [font=Courier New]ständig[/font] [font=Times New Roman]wechselnde[/font] [font=Tahoma]Schriftart[/font] oder [color=red]gar[/color] [color=green]Schriftfarbe[/color]. Für den reinen Fließtext sollte nicht auf eine andere Schriftart und auch nicht auf eine andere Schriftfarbe zurückgegriffen werden. Wenn man Textteile herausheben möchte, kann man dies mit [i]Kursivschrift[/i], [b]Fettschrift[/b], [u]unterstrichen[/u] oder einem BBcode Tag, z.B.: code, html, php oder quote tun.

[b]Beispiel für das code-Tag:[/b]

Führe dann diesen Befehl in der Eingabeaufforderung aus:
[code]ipconfig /all[/code]

[b]Beispiel für das php-Tag:[/b]

Füge diesen PHP-code in deinen Quelltext ein:
[php]this->getPhpCodeTagFromExample();[/php]

[b]Beispiel für html-Tag:[/b]

Füge diesen HTML Text in dienen Quelltext ein:
[html]<a href="http://www.tweakpc.de">TweakPC.de</a>[/html]

[b]Beispiel für Zitate:[/b]

Zitat ohne Quelle:
[quote]Not only in computer-science, but also in computer-science![/quote]

Zitat mit Quelle als Kursivschrift:
[quote][i]Dr. rer. nat. Jörg-Erich Werth[/i]
Not only in computer-science, but also in computer-science![/quote]

Zitat mit Quelle als Angabe:
[quote=Dr. rer. nat. Jörg-Erich Werth]
Not only in computer-science, but also in computer-science![/quote]

Zitat mit Quelle als Angabe + Threadverweis:
[quote=Dr. rer. nat. Jörg-Erich Werth;339300]
Not only in computer-science, but also in computer-science![/quote]

[b][size=3]1.2 Kein zentriertes Layout![/size][/b]

Der optimale Lesefluss ist bei linksbündigem Text gegeben. Den ganz normalen Fließtext solltest du also auch nicht zentriert oder gar rechtsbündig angeordnen. Dies trifft natürlich nicht auf Überschiften zu.

[b][size=3]1.3 Absätze & Überschiften[/size][/b]

Möchte der Leser einen Text schnell erfassen, ist es unablässlich den Text mittels Überschiften und Absätzen zu strukturieren. So erleichterst du deinen Lesern das schnelle Erfassen des Inhalts, ohne ihn gleich den ganzen Text sequentiell (am Stück) lesen lassen zu müssen. Auch kann der Leser sich dann bestimmte Textstellen leichter heraussuchen und - hier im Forum besonders wichtig - auf diese in anderen Threads verweisen.

Mein persönlicher Tipp: Überschriften fett und in einer größeren Schriftgröße darstellen.

Verwendest du zusätzlich noch Nummerierungen in den Überschriften, erleichtert dies die Navigation im Text ein weiteres Mal. Hierbei solltest du den Hauptteil in einige Kapitel unterteilen und den Unterkapiteln eine eingerückte Nummerierung vergeben.

[b][size=3]1.4 Bilder aus der TweakPC.de Bildergalerie verlinken[/size][/b]

Bilder solltest du aus der TweakPC.de Bildergalerie verlinken. So wird sichergestellt, dass der Leser sowohl Bilder als auch Text einsehen kann. Außerdem müssen keine weiteren Daten von anderen Servern angefordert werden, was die Darstellungsgeschwindigkeit unter Umständen verbessern kann.
Dabei solltest du darauf achten, dass Bilder die größer als 300x300 Pixel sind, verkleinert oder als Thumbnail verlinkt werden. So wird der Lesefluss nicht allzusehr gehemmt und der Leser sieht dennoch etwas vom Bild.

Wie die Bildergalerie funktionier, hat redfalcon in diesem Tutorial beschrieben: [url=http://www.tweakpc.de/forum/tutorials/37608-how-screenshots-tweakpc-foren-gallery-hochladen.html]How-to: Screenshots in die TweakPC Foren Gallery hochladen[/url]

[size=4][b]2. Struktur[/b][/size]

Die Struktur zeigt, dass der Autor das Thema von vorn bis hinten im Detail durchdacht hat und so dem Leser das Verständnis erleichtern kann. Je komplexer ein Thema, desto mehr Aufwand sollte in Vorbetrachtungen und Einleitungen investiert werden.

[b][size=3]2.1 Abstract / Vorwort / Inhaltsverzeichnis[/size][/b]

Ein Abstract beschreibt in wenigen Sätzen was den Leser im Folgenden erwartet. Hier sollte der gesamte Inhalt reflektiert werden, was sich der nun kommende Text zu erörtern gedenkt. Ein solcher Abstract hilft dem Leser einen schnellen Überblick über den Text zu gewinnen und einzuschätzen, ob der Inhalt für ihn im Speziellen lesenswert ist.

Ein Vortwort erläutert ggf. die Intention des Autors, enthält einige einleitende Worte oder zeigt einen Hinführung zum Thema. Mit einem Vorwort ist es leichter einen Leser auf das Thema "einzustimmen" als ein Start mit dem blanken Inhalt.

Ein Inhaltsverzeichnis zeigt grob die nun folgende Struktur auf und erleichtert dem Leser gezielt gewünschte Informationen im Text zu finden. Je komplexer ein Tutorial bzw. ein Erfahrungsbericht, desto eher solltest du erwägen ein solches Inhaltsverzeichnis an den Anfang des Textes zu stellen. Im einfachsten Falls ist das einfach nur eine Liste aller Überschriften. Besteht ein Tutorial aus mehreren Beiträgen, weil z.B. mehrere Autoren unabhängig daran mitgewirkt haben, so empfiehlt es sich auf diese Beiträge vom Inhaltsverzeichnis aus zu verlinken.

[b][size=3]2.2 Hauptteil[/size][/b]

Den reinen Inhalt solltest du ebenfalls gut unterteilt (in Kapitel mit schönen Überschriften) dargestellen.
Vorteile:[list][*]Text lässt sich leichter überfliegen.[*]Bei Feeback, Fragen, Verbesserungen kann man sich direkt auf das Kapitel beziehen[*]Textstellen lassen sich leichter auffinden.[/list]
Im Hauptteil solltest du dem Verständnis des Themas wegen nicht sofort auf das Kernthema konzentrieren, sondern zunächst einige Worte bzw. Sätze für eine Erklärung der Umstände aufwenden.
Folgende Fragen sollten sich dabei für den Leser beantworten:[list][*]Gehört ich ich zur Zielgruppe des Tutorials?[*]Was benötige ich, damit ich den Inhalt des Tutorials nachvollziehen kann?[*]Welche Grundlagen für das generelle Verständnis des Themas benötige ich und wo kann ich diese Grundlagen ggf. nachlesen?[*]Welche Gefahren bzw. Einschränkungen könnten auf mich zutreffen, wenn ich den Inhalt nachvollziehen würde?[/list]
Trocken ist alle Theorie, daher hier ein Beispiel dafür: Benutzer "TollerTutorialSchreiber" erstellt eine Anleitung zum Übertakten einer Graphikkarte mit dem RivaTuner. TollerTutorialSchreiber legt gleich so los: "geh im Rivatuner auf die Hardwaresettings und dreh die Memclock bis auf 1001 MHz hoch".
Besser wäre es, wenn TollerTutorialschreiber folgende Punkte im Vorfeld erwähnen würde:[list][*]Zur Zielgruppe des Tutorials gehören Übertakter, welche mehr aus ihrer jetztigen Hardware herausholen wollen.[*]Um dem RivaTuner Tutorial zu folgen benötigt man eine Graphikkarte, die von der Software unterstützt ist sowie die Software selbst. Beides kann man [url=http://www.guru3d.com/index.php?page=rivatuner]hier[/url] nachlesen.[*]Als Grundlagenversätndnis sollte der Leser Wissen über das Prinzip von Takt, Übertakten und dem Umgang mit Hardware an sich mitbringen.[*]Übertakten kann unter Umständen zu Beschädigung der Hardware führen. Viele Hersteller schließen dann Garantie aus. Man sollte sich diesem Risiko bewusst sein.[/list]
Verwendestt du oft Links zu anderen Seiten, solltest du die Links gleich zusammenkopieren oder notieren, um sie später in einem Quellenverzeichnis aufzulisten. So geht nichts verloren und der Leser merkt, dass man sich hier auf Fakten bezieht und nicht wahlfrei Sachen aus der Luft greift.

[size=3][b]2.3 Zusammenfassung / Schlussteil[/b][/size]

Eine Zusammenfassung am Ende eines Textes wiederholt [u]nicht[/u] den Inhalt erneut (dafür ist der Abstract da), sondern weist den Leser ggf. auf einige sehr wichtige Stellen hin oder erstellt ein Fazit aus dem Gelesenen.

Im Schlussteil kann ebenfalls auf weiterführende Links verwiesen werden, wo der Leser Informationen zum Thema findet, die im Tutorial nicht direkt angesprochen wurden. So kann man z.B. mit recht einfach gehaltenen Tutorials den Leser auf größere, komplexere Themen hinweisen bzw. hinführen.

Hast du nicht allein geschuftet, sondern noch ein wenig Zuarbeit erhalten, versteht es sich von selbst seinen Dank an die Mitwirkenden auszusprechen. So sicherst du dir deren Wohlwollen und zeigt Anerkennung für gegebene Leistung.

[size=4][b]3. Inhalt[/b][/size]

Der Inhalt ist die Seele des Textes. Hier solltest du auf eine hinreichende Menge, einen guten Schreibstil mit Beachtung der Rechtschreibung und Grammatik achten.

[b][size=3]3.1 Mindestmenge[/size][/b]

Eben gerade herausgefunden, wo man den Haken setzen muss, damit man in Windows XP den Desktop auf einen zweiten Monitor erweitern kann? Schnell noch eben ein "Tutorial" schreiben, welches dann aus 5 Sätzen und ggf. einen Bild besteht? Nicht wirklich!
Ein gutes Tutorial sollte ein recht komplexes Thema (oder mehrere weniger komplexe) abbilden, sodass es ausreichend Stoff für einen guten Text abgibt. Hast dun ein interessantes Thema beschrieben und landet bei vielleicht einer Bildschirmseite, solltest du nochmal überdenken, ob nicht noch folgende Teile ausbaufähig sind:[list][*]Einführung & Erklärungen - Habe ich alle komplexen Begriffe erläutert oder ggf. mit einem Lexikon verlinkt?[*]Weiterführende Themen - Welche Bereiche oder andere Themen werden durch mein Thema noch berüht? Wo findet sich Lektüre zum anknüpfen?[*]Beispiele, häufig gestellte Fragen, anschauliche Bilder![/list]

[b][size=3]3.2 Schreibstil[/size][/b]

Hier erwartet niemand einen Aufsatz der für eine Dissertation reichen würde, noch eine medizinische Facharbeit. Aber ein wenig Mühe solltest du dir bei den Formulierungen und Ausdrucksweisen schon geben.

Ausdrucksweisen wie "ey dann pflanschst du ma eben dat Dingens da ran" verbieten sich von selbst.

Ebenso solltest du versuchen, bestimmbare Dinge bei ihrem genauen Namen zu benennen. Wenn man z.B. über die Gruppenrichtlinien von Microsoft Windows schreibt und sagt "in Windows XP tippst du dann gpedit.msc bei ausführen ein" kann man sichergehen, dass in der Fragen und Feedbackrunde einige Stimmen laut werden, die berichten, dass es bei ihnen nicht funktioniert. Ganz klar - die haben Windows XP Home - und den Gruppenrichtlinieneditor gibt es nur bei Windows XP Professional.

[size=3][b]3.3 Rechtschreibung und Grammatik[/b][/size]

Es gibt Einige, die behaupten, man könne Texte verstehen, solange man bei den Wörtern den ersten und letzten Buchstabe erhält. Das mag zwar stimmen, sollte aber nicht auf die Probe gestellt werden. Ein guter Text sollte eine gute Rechtschreibung und Grammatik aufweisen. Hast du selbst nicht so das Händchen dafür, gibt es sicher einige hier im Forum, die Texte vor ihrer Veröffentlichung gegenlesen würden.
Zum Beispiel könnt ihr euch bei solchen Sachen immer vertrauensvoll an euren tele wenden. ;-)

Hier ein Beispiel für grandiose Rechtschreibung:

[quote]Afugrnud enier Sduite an enier Elingshcen Unvirestiät ist es eagl, in wlehcer Rienhnelfoge die Bcuhtsbaen in eniem Wrot sethen, das enizg wcihitge dbaei ist, dsas der estre und lzete Bcuhtsbae am rcihgiten Paltz snid. Der Rset knan ttolaer Bölsdinn sien, und du knasnt es torztedm onhe Porbelme lseen. Das ghet dseahlb, wiel wir nchit Bcuhtsbae für Bcuhtsbae enizlen lseen, snodren Wröetr als Gnaezs[/quote]

Aber macht das bitte nicht nach, danke. ;-)

[b][size=3]3.4 Vermutungen vs. Erfahrungen vs. Fakten[/size][/b]

Schreibst du von Inhalten, von denen du vermutest, dass sie wahr sind, solltest du zumindest versuchen eine Quelle mit anzugeben, welche diese Aussage stützt. Das hinterlässt nicht den Eindruck einer vagen Vermutung, die als Fakt dargestellt wurde.

[size=4][b]4. Positive Beispiele[/b][/size]

Die folgenden Links sollen zeigen, wie man es richtig machen kann.

[size=3][b]4.1 Tutorials[/b][/size][list][*][url=http://www.tweakpc.de/forum/tutorials/37264-pc-reinigung.html]Wie befreie ich meinen PC am besten von Staub?[/url][*][url=http://www.tweakpc.de/forum/tutorials/29413-eine-einfuehrung-in-smart-smartmontools-linux.html]Eine Einfuehrung in SMART (und die smartmontools unter Linux)[/url][*][url=http://www.tweakpc.de/forum/tutorials/37608-how-screenshots-tweakpc-foren-gallery-hochladen.html]How-to: Screenshots in die TweakPC Foren Gallery hochladen[/url][*][url=http://www.tweakpc.de/forum/tutorials/17797-netzwerk-was-ist-dns-und-nutze.html]Was ist DNS? Und wie nutze ich das?[/url][/list]

[size=3][b]4.2 Erfahrungsberichte[/b][/size]
[list][*][url=http://www.tweakpc.de/forum/erfahrungs-und-testberichte-usern-fuer-user/43421-erfahrungsbericht-scythe-infinity-cpu-tower-kuehler.html]SCYTHE INFINITY CPU TOWER KÜHLER SCINF-1000[/url][*][url=http://www.tweakpc.de/forum/erfahrungs-und-testberichte-usern-fuer-user/25516-digitalkamera-kodak-easyshare-cx7530.html]Digitalkamera: Kodak EasyShare CX7530[/url][*][url=http://www.tweakpc.de/forum/erfahrungs-und-testberichte-usern-fuer-user/34238-roundup-x1800xt-stockcooler-vs-zalman-vf700cu.html][Roundup]: X1800XT Stockcooler VS. Zalman VF700Cu VS. Zalman VF900Cu[/url][*][url=http://www.tweakpc.de/forum/erfahrungs-und-testberichte-usern-fuer-user/37877-opera-9-ein-erster-eindruck.html]Opera 9 - Ein erster Eindruck[/url][/list]

[size=4][b]5. Spezielle Hinweise für Tutorials/Erfahrungsberichte im TweakPC.de Forum[/b][/size]

Hier noch einige Punkte, die du bei Tutorials und Erfahrungsberichten hier im TweakPC.de Forum beachten sollte:

[b][size=3]5.1 Tutorial in der Übersicht verlinken[/size][/b]

Möchtest du dein Tutorial gern in der sortierten Übersicht haben wollen ([url=http://www.tweakpc.de/forum/tutorials/27682-tutorials-fertige-und-gewuenschte-im-uberblick.html]Tutorials: Fertige und gewünschte im Überblick[/url]), so sende bitte mir (tele) oder Stefan eine [url=http://www.tweakpc.de/forum/faq.php?faq=faq_tpc_x#faq_tpc_faq_x_regel_3]PN[/url] und wir fügen das neue Tutorial der Liste hinzu. So können Tutorials recht schnell anhand einer Einordnung gefunden werden. Sollte einer von uns beiden durch einen ganz dummen Zufall mal nicht online sein, übernimmt das bestimmt auch gern jeder andere Moderator, der gerade anwesend ist.

[b][size=3]5.2 Wie gehe ich mit Zusatzposts von anderen Nutzern um?[/size][/b]

Ergänzen sie das Thema sollten solche Beiträge im Tutorial-Thread verbleiben. Zum Beispiel können das Darstellungen aus einem anderen Blickwinkel, Ergänzungen zu eventuell nicht in die Tiefe betrachteten Themen oder ganz einfach das gleiche Thema (z.b. Graphikkarte mit Rivatuner übertakten) nur mit einer anderen Software (z.B. Graphikkarte mit Software-XYZ übertakten) sein.

[b][size=3]5.3 Wie gehe ich mit Fragen, Feedback, Diskussion etc. um?[/size][/b]

Diese werden normalerweise in den Diskussions-Thread gesetzt. Sollten dennoch einmal Benutzer so etwas in das Tutorial selbst posten, kann man den Beitrag einfach melden. Ein Moderator verschiebt dann die entsprechenden Beiträge.

[size=4][b]6. Nützliche Programme / Weiterführende Links[/b][/size]

[b][size=3]6.1 Programme[/size][/b]

- [URL="http://www.pixelman.ch/pixelmansoftware/index.php?article_id=17"]Easycomposer [/URL]- Offline BBcode Texteditor. Damit kann man offline Texte für Foren, die BBcode verwenden (wie dieses Forum hier) erstellen und diese Texte dann einfügen. Besonders bei größeren Tutorials, die nicht in einem Rutsch geschrieben werden ist dies hilfreich.

[b][size=3]6.2 Quellen[/size][/b]

[url=http://www.guru3d.com/index.php?page=rivatuner]RivaTuner[/url]
[url]http://de.wikipedia.org/wiki/Lesefluss[/url] (und alle dort genannten Quellen)

__________________________________________________________________________________

Diskussion, Lob, Kritik, Anregung und Feeback bitte im [thread=49791]Diskussionsthread[/thread] posten, Danke.

Meinen persönlichen Dank für Beiträge und Zuarbeit an: LiTe, redfalcon, Pirke, dr_Cox