Amtliche Schulverwaltung
Sie befinden sich hier: start » alle » layoutbestimmungen_dokumentation

Layoutbestimmungen für die Dokumentation


Um eine Vereinheitlichung des Layouts bei der ASV-Dokumentation zu erreichen, werden folgend die Vorgaben beschrieben, wie sie in der ASV Einführung umgesetzt worden sind.
Allgemeine Hinweise zum Erstellen und Bearbeiten einer Seite finden Sie in der Wikihilfe.

Gestaltung des Textes

Inhaltliche Vorgaben:

  • Keine Beschreibung von Trivialitäten, wie etwa ein Bild des Diskettensymbols.
  • Die Beschreibung der (Meta-)Aktion, die den Vorgang erläutert, ist einer einfachen Handlungsoption stets vorzuziehen.
    Beispiel: „Um eine neue Sammeländerung zu definieren, klicken Sie auf die Schaltfläche Neuen Datensatz hinzufügen.“
  • Keine Wertungen in den Artikeln.
  • Als Ergänzung kann bei jeder erstellten Seite einen Verweis angegeben werden, mit welcher ASV-Version dieser Eintrag erstellt worden ist

Sprachliche Empfehlungen:

  • Keine unnötigen Abkürzungen:
    Beispiel: etc. oder usw. können bleiben, eine Abkürzung wie städt. für städtisch muss nicht sein.
  • Aktiv dem Passiv bevorzugen.
  • Zahlen zwischen eins und zwölf ausschreiben.
  • Vermeidung von bzw., besser und / oder verwenden.
  • Rechtschreibfehler, insbesondere Kommafehler sorgfältig aufspüren und entfernen.
  • Klare, knappe Sätze, keine Schachtelungen.
  • Korrekte Wortstellung beachten. Dazu gehört auch das Nachklappen von Verben:
    nicht: „Es empfiehlt sich die Bilder, deren Größe 10m*15m überschreitet, anzusehen.“
    besser: „Es empfiehlt sich die Bilder anzusehen, deren Größe 10m*15m überschreitet.“
  • Keine bildliche oder kindliche Sprache:
    nicht: „Kann-Fehler: ASV ist der Meinung, dass hier ein Fehler vorliegt, der nicht zwingend korrigiert werden muss, aber einer gezielten Prüfung unterzogen werden sollte. Diese Fehler sind als Hinweise zu verstehen und entsprechend zu überprüfen. Kann-Fehler verhindern die Abgabe einer UP/US nicht.“
    besser: „Kann-Fehler: Die Prüfung entdeckt eine Dateneingabe, die auf einen möglichen Fehler hindeutet, einer gezielten Prüfung unterzogen werden sollte, aber aus technischer Sicht die UP/US nicht verhindert.“

Formatierungen:

  • Überschriften:
    • Nützliche Hinweise bei der Erstellung von Überschriften erhalten Sie in der Syntax im Punkt 1.3 Überschriften.
    • Am Anfang eines Artikel steht immer eine Überschrift der Ebene 2.
    • Bei einer weitere Untergliederung werden Überschriften der Ebene 3 (blaue Schrift) verwendet.
    • Ein Inhaltverzeichnis zur Seite ist nicht vorgesehen.
    • Eine mögliche Anwendung der Überschriften sehen Sie in der Beispielseite.
  • Bei der Verwendung von Links soll eine zielführende Bezeichnung gewählt werden.
    nicht:Hier können Sie ausgewählte Datensätze prüfen, um vorhandene Fehler zu erkennen.“
    besser: „Um vorhandene Fehler zu erkennen, können Sie ausgewählte Datensätze prüfen.“
  • Bei einer Aufzählung von mehreren, weiterführenden Links ist, so wie auf der Beispielseite, jeweils eine Kurzbeschreibung anzustreben.
  • Befehle und Menüs werden kursiv geschrieben.
  • Befehlsfolgen werden in Kurzform mit Freizeichen vor und nach dem Schrägstrich angegeben: Menü / Untermenü / Befehl.
  • Tasten und Tastenkombinationen (z.B. STRG + UMSCHALT) in Versalschrift (nur Großbuchstaben).

Verwendung von Wraps:

  • Sehr sparsame Verwendung.
  • Höchstens zwei pro Seite.
  • Linksbündige Orientierung.
  • Ausschließlich verwendeter Wrap-Typ: „Info“
  • Vorgegebene Breite: 85%
  • Zur Anzeige werden abgerundete Ecken verwendet.
  • Weitere Informationen erhalten Sie in der Wikihilfe bei der Verwendung des WRAP-Plugins.

Gestaltung der Screenshots

  • Je nach Größe des Bildausschnitts ist eine möglichst einheitliche Breite der Screenshots auf einer Dokuseite anzustreben.
  • Screenshots immer linksbündig.
  • Um unscharfe Screenshots zu vermeiden, ist ein Bild im Dateiformat *.png empfehlenswert.
  • Vollbildschirm immer mit einer Auflösung von 1280*720.
  • Keine Schwarzweiß-Screenshots.
  • Vor dem Screenshot muss unbedingt ein Zeilenende durch zwei Backslashes \\ angeben werden, sonst kann bei breiten Bildschirmen das Bild noch neben den Text „geklebt“ werden.
  • Keine Screenshots, bei denen man nicht erkennt, wo sich der beschriebene Teil im ASV-Fenster befindet. Vielmehr sollen bedeutende Teile eines Screenshots durch einen roten Rahmen hervorgehoben werden.
  • Wenn mehrere Teile eines Screenshots beschrieben werden, können diese Bereiche mit Nummern gekennzeichnet werden.
  • In der Beispielseite sehen Sie eine mögliche Umsetzung dieser Vorgaben.

Externe Software

Für die Erstellung der Screenshots gemäß den dargelegten Layoutbestimmungen ist es empfehlenswert, folgende externe Software zu verwenden:

Greenshot

Das Tool Greenshot ist hilfreich beim Abfotografieren bestimmter Bildschirmbereiche sowie für die Erstellung der Nummern.
Im Greenshot-Editor gibt es in der linken Leiste die Funktion Zähler hinzufügen.
Die Hintergrundfarbe stellen wir auf den Blauton #007FFF um. Der Durchmesser der Kreise wird nicht verändert.


Sizer

Für einen Screenshot des vollen ASV-Bildschirms bei genau 1280*720 Pixel muss man ein entsprechendes Werkzeug verwenden.
Eine konkrete Möglichkeit ist das Werkzeug Sizer:
Hier lädt man sich einfach den neusten Entwicklungsordner (Sizer 3.4 Dev Build 482) herunter und extrahiert diesen. Das Werkzeug muss nicht installiert werden, sondern kann einfach durch das Klicken des sizer.exe -Files gestartet werden. Nach dem Start wird bei der Größenänderung eines Fenster seine momentane Große angezeigt. Ein Klick mit der rechten Maustaste auf das Maxi-/Minimieren-Symbol erlaubt es zudem, vorgegebene Bildschirmgrößen (in Pixel) auszuwählen.

IrfanView

Bildausschnitte bei vorgegebener Größe lassen sich mit dem Werkzeug Irfan-View vornehmen. Hierzu erstellt man zunächst einen Screenshot des kompletten Fenster (Alt-Drucken) und kopiert diesen einfach mit Strg-V in die IrfanView-Oberfläche. Dann wählt man unter Bearbeiten den Eintrag Spezielle Markierung erstellen. Dieser ermöglicht es, eine konkrete Größe vorzugeben, die dann durch einen entsprechenden Rahmen visualisiert wird. Bei gedrückter rechter Maustaste lässt sich dieser Rahmen dann verschieben und der gewünschte Teil mit Strg-X ausschneiden.