Hier ein paar Tipps zum Verfassen von Artikeln damit die Website einigermassen homogen daherkommt.
Publikum
Auch wenn unser Tätigkeitsfeld sehr Technik-lastig ist sollen die Artikel, welche sich nicht direkt um Firmware Flashen und Antennenbau handeln auch von Normalsterblichen verstanden werden können. Dies gilt vor allem für die Seiten, welche bei der Navigation Links aussen sind. Wir wollen potentielle Neuzugänger ja nicht bereits vor ihrem ersten Wireless-Träff in die Flucht jagen.
Inhalt
- DRY (Dont repeat yourself) gilt nicht nur für Programmierer. Wenns schon einen Artikel hat brauchts dessen Inhalt nicht noch in einem Zweiten. Dafür gibts Links.
- Überschrift sollten zum Inhalt passen und umgekehrt. Vor allem wichtig in der FAQ.
Formatieren
- Einmal Zeilenschaltung ergiebt einen Zeilenumbruch, zweimal Zeilenschaltung einen neuen Absatz. Absätze sehen gut aus!
- Mit den Überschrifts-Tags kann mann kleinere und noch kleinere und ganz kleine Überschriften machen. Überschriften sehen auch gut aus!
Überschrift
Unterüberschrift
Unterunterüberschrift
- Aufzählungslisten sehen auch gut aus und funktionieren so:
- Ein Bier
- Zwei Bier
- Drei ...
- Weitere Informationen im Bla-Flyer (PDF):
http://blabla.bla/flyer.pdf
Links
Externe Links gehören grundsätzlich auf die Links-Seite (DRY). Ausnahmen sind Quellenverweise und weiterführende Links, die eng mit dem Thema des Artikels zusammenhängen. Der Übersicht zuliebe sollten externe Links am Ende des Artikels aufgelistet sein und nicht direkt im Artikel verbaut werden. Auch ist es nett, wenn der Dateityp angegeben wird, falls es sich nicht um eine Website handelt. Der Code sieht ungefähr so aus:
...blabla blabla blabla, blabla blabla blabl ablablabla blablalbabla. blablablabla blabla, blabla blabla blabla, blabla blabla blabl ablablabla blablalbabla. blablablabla blabla.
Hinweis: Das installierte urlfilter-Modul erkennt komplette Links automatisch und erzeugt selbständig den nötigen HTML-Code.
Interne Links sind überall OK - auch im Text - falls der Lesefluss nicht zu stark beinträchtigt wird. Interne Links sind immer relativ anzugeben:
Die Dokumentation ist mir zu langweilig...
Revisionskontrolle
Falls an einem Artikel umfangreiche Änderungen gemacht wurden sollte eine neue Revision erstellt werden. Dazu muss eine kurze Protokollnachricht eingegeben werden und unter "Veröffentlichungseinstellungen" das Häckchen bei "Neue Revision erstellen" gesetzt werden.