Peer2Peer & Computerforum - HowTo allgemein

Wie erstelle ich ein HowTo

Wie erstelle ich ein HowTo

Wie erstelle ich ein HowTo

Ein HowTo zu erstellen ist leichter als man denkt!
Behält man ein paar Grundregeln im Auge, kann man im handumdrehen sehr informative "Beschreibungen" erstellen.
Natürlich kann jeder sein HowTo nach eigenem Ermessen gestalten,
ich möchte mit dieser "Anleitung" lediglich das Erstellen ein wenig erleichtern / ein Grundgerüst zeigen.


Was kann das Programm (Kurzinfo) :
Gebt eine kurze Übersicht, was man mit diesem Programm alles machen kann, bzw. was einen im folgenden HowTo erwartet.

Beispiel:
- Mit dem "Programm XYZ" können XYZ in ZYX umgewandelt werden, ohne viel Aufwand ... ;
- Das Programm sucht selbständig nach XYZ und entfernt diese ... ;
- Wer öfters mal XYZ-bearbeitet, kann mit der folgenden Beschreibung ... ;

Grundlegende Angaben zum Programm :
In einem HowTo sollte folgendes enthalten sein:

1. Name des Programmes
2. Herstellerseite
3. Systemvorraussetzungen
4. Downloadlink
5. Kostenpunkt
6. Downloadgröße
7. Gibt es eine De-Installfunktion

zu 1.)
Damit jeder weiß, um wleches Programm es sich handelt, den genauen Programmnamen (inkl. Versionsnummer) angeben.
Oftmals sind in anderen Versionen bestimmte Vorgehensweißen anders, "Arbeitspunkte" nicht vorhanden.
zu 2.)
Ein Link zur Herstellerseite sollte nicht fehlen.
Wer möchte, kann sich so erstmal einen ersten Eindruck über das Programm holen.
zu 3.)
Manche Programme (z.B. bei Videoschnitt) erheben oftmals sehr Ansprüche an das System.
Sollte ein Programm also z.B. 512MB Arbeitsprecher benötigen, sollte man darauf hinweißen.
zu 4.)
Wenn es das Programm als Freeware, Shareware, Testversion im Internet gibt,
kann man einen Downloadlink posten.
Meist ist es ratsam, als "Quelle" einen Link auf der Herstellerseite zu wählen.
Dieser Link sollte auch nach längerer Zeit nicht ins "Leere führen".
zu 5.)
Wer etwas zu den Kosten des Programmes sagen kann, sollte dies nicht auslassen.
Ein Hinweiß à la: Freeware, Shareware, Testversion ist für den "Hilfesuchenden" oft schon ausreichend.
zu 6.)
Wie groß ist die zu herunterladende Datei
zu 7.)
Besitzt das Programm eine De-Installfunktion? ->

Das eigentliche HowTo :
Um eine übersichtliche Gestaltung zu schaffen, sollte man wichtige Textfrasen / Wörter durch "Fettschrift" hervorheben.
Wenn mehrere Funktionen erklärt werden, diese in einzelne Absätze mit eigener Überschrift packen.
Bei Überchriften ruhig eine etwas größere Schrift, eine andere Farbe, Unterstriche, ... verwenden;
alles was auffällt ist erlaubt!
Ein HowTo soll "Ungeholfenen" eine Funktion / ein Programm näher bringen.
Daher ist es ratsam, jeden einzelnen durchzuführenden Arbeitsschritt zu erklären, bzw. zu nennen.
Gerade wenn die Grundeinstellungen eines Programmes abgeändert werden müssen,
sollte auf diesen Punkt eingegangen werden.
Stellt Euch also einen Anfänger / ein Kind vor, dem Ihr das Programm erklärt =>
lieber einen Handgriff zu viel als zuwenig erklärt!
Die Beschreibung sollte mit informativen Bildern (Screenshots) untermalt werden.
Bei Screenshots sollte man auf folgendes achten:

1. Die Breite / Länge der Bilder sollte max. 800x600 Pixel sein
2. lieber einen Ausschnitt, als das ganze Bild einfügen
3. Die Datenmenge des Bildes sollte gering sein
4. Wichtige "Details" auf dem Bild einrahmen

zu 1. und 2.)
Zu große Bilder sprengen meist den Rahmen des Internetbrowsers,
so dass das komplette Bild nur noch per Scrollbalken angezeigt werden kann.
Es empfiehlt sich, das jeweilige Arbeitsfenster des Programmes vor dem anfertigen eines Screenshots zu verkleinern.
Falls dies nicht möglich ist, einfach die Bildschirmauflösung reduzieren!
So ist zum einen der "Ausschnitt kleiner", zum anderen ist die Datenmenge geringer (Punkt 2)
Werden nur bestimmte "Teile" des Programmfensters zur "Erklärung" benötigt, ist es ratsam,
auch nur diesen Part "abzulichten"
Einen Screenshot per Fotobearbeitungsprogramm in der Größe zu verändern führt meist zu unleserlichen Ergebnissen.
zu 3.)
Je größer die Datenmenge, desto besser ist natürlich der erstellte Screenshot.
Allerdings ist nicht jeder User mit DSL unterwegs -> ein Bild mit 2MB hat eine sehr lange Ladezeit!
Daher empfiehlt es sich, als Dateityp png, zur Not auch jpeg zu verwenden:
png -> manchmal etwas größere Datenmenge, aber sehr gute Qualitätsergebnisse
jpg -> bei starker Komprimierung relativ schlechte Qualität
Wer sich nicht sicher ist, welcher Dateityp besser geignet ist, kann den Screenshot einmal als jpg und einmal als png abspeichern.
Im direkten Vergleich der einzelnen Bilder kann man sich dann für einen Dateityp entscheiden!
zu 4.)
Um "markante" Punkte auf dem Screenshot hervorzuheben, können diese eingerahmt / unterstrichen oder bei z.B.: "mehreren Feldern" mit Zahlen versehen werden.

Wie man einen Screenshot erstellt, könnt Ihr -> hier nachlesen;
wie man sich einen kostenlosen Webspace für die Bilder anlegt steht -> hier;
wie die Bilder auf den Webspace hochgeladen werden ist -> hier nachzulesen;
und wie Ihr letzendlich die Screenshots im HowTo einfügt steht -> hier