Hilfe:Anleitungen schreiben

aus openSUSE, der freien Wissensdatenbank

Dieser Artikel ist ziemlich kurz. Wenn Sie ihn erweitern möchten, dann freuen wir uns über ihre Hilfe. Lesen Sie bitte auch den OpenSUSE Stilleitfaden.
Wenn Sie ein wenig Beschäftigung suchen, schauen Sie sich doch einfach mal die anderen Erweiterungskandidaten an.

Die Absicht dieses Artikels ist es, eine Einführung in das Schreiben von Anleitungen zu geben, damit die Dokumentation einheitlich ist.

Allgemein

Eine Anleitung ist eine Schritt-für-Schritt - Dokumentation, die helfen soll ein bestimmtes Problem mit möglichst wenig Theorie zu lösen. Interessant wäre stattdessen eine Sektion mit dem Titel Literatur, die Tipps für Bücher etc. enthält. Das würde auch Lesern mit mehr Interesse zum entsprechenden Thema entgegen kommen, aber der Artikel selber sollte mehr Praxis enthalten.

Die Literatur sollte einfach zu finden sein. Sog. "Dead Links" (Links auf Seiten, die nicht mehr existieren) oder Bücher, die vergriffen sind, sind unbrauchbar.

Bitte schreiben Sie keine Anleitung über Themen, über die schon etwas geschrieben wurde. Viele Anleitungen finden sich auf http://www.tldp.org

Sie können eine Sammlung von Anleitungen von CD/DVD oder aus dem Internet installieren, indem Sie YaST benutzen. Um eine bestimmte Anleitung zu finden, starten Sie YaST und tippen Sie als Suchwort howto ein. Nach der Installation können Sie die Anleitung in

/usr/share/doc/howto

finden.

Es gibt bereits eine große Ansammlung von Anleitungen im Wiki, benutzen Sie dazu bitte einfach die Suchfunktion.

Benötigen Sie Hilfe?

Dokumentation: Verfügbare Wiki-Artikel und Dokumentation. Kommunikation: Weitere Möglichkeiten Hilfe zu erhalten.

Falls Sie das erste Mal eine Anleitung schreiben, können Sie sich gut an ihnen orientieren.

Titel

Das Ende des Titels sollte Anleitung lauten. Das sortiert die Artikel im Wiki besser.

Sektionen

• Einführung - Welches Problem wird bei der Befolgung der Anleitung gelöst? Beschreiben Sie genau die System-Versionen und die benötigte Hardware (benutzen Sie dazu am besten die Vorlagen).
• Autoren - Erwähnen Sie bitte die Leute, die Ihnen beim Schreiben des Artikels in irgend einer Weise geholfen haben. OpenSource Software ist meistens kostenlos, das heißt aber nicht, dass die Entwickler nicht genannt werden sollten.
• Vorwissensanforderungen - was Software, Hardware u.s.w. betrifft.
• Vorgehensweise
• Hinweise - Kann ausfallen, wenn die Vorgehensweise z.B. sehr kurz ist.
• Literatur - s.o.

Layout

Das Layout bestimmt das Aussehen der Seite. Lesen Sie dazu bitte den OpenSUSE-Stilleitfaden

Literatur

• http://tldp.org/docs.html#howto
• LDP templates