SLADE

Reiter

Hilfe-Wiki Arbeit

Anleitung zur Überarbeitung der Dokumentation mit Screenshots

Zu Beginn: Vielen lieben Dank für Eure Arbeit und Hilfe!

Bitte überprüft die Seiten und Objekte systematisch und achtet dabei auf Folgendes:

  1. Bezeichner prüfen: Vergleicht alle Bezeichnungen in der Anleitung mit der aktuellen Oberfläche. Stellt sicher, dass die Begriffe überall übereinstimmen.
  2. Struktur und Ablauf kontrollieren: Überprüft, ob sich die Struktur oder der Ablauf geändert hat. Falls Schritte oder Vorgehensweisen angepasst wurden, passt die erklärenden Texte entsprechend an.
  3. Screenshots bearbeiten:
    • Erstellt neue Screenshots, wenn sich die Oberfläche geändert hat.
    • Die Markierungen in den Screenshots sollen im Farbcode #a56704 erfolgen.
    • Markiert im Screenshot immer den zum beschriebenen Schritt passenden Bereich und fügt die Schrittnummer (z. B. 2) in der Farbe #a56704 ein.
    • Nutzt keine verschachtelten Nummerierungen wie „3.1.2“. Alle Schritte sollen fortlaufend und eindeutig nummeriert sein (1, 2, 3 ...).
    • Achtet darauf, dass der Screenshot thematisch zum beschriebenen Abschnitt passt.
    • Erstellt eine Bildunterschrift im Format: „Bildbeschreibung zu 4.2.1 bis 4.2.3“.
      Habt keine Angst, etwas zu verändern – wir können alles wiederherstellen.
  4. Mit Hilfe von Blöcken könnt ihr bestimmte Informationen hervorheben. Nutzt diese jedoch bitte nicht inflationär, sondern gezielt dort, wo es sinnvoll ist. Es gibt beispielsweise Blöcke für „Tipps/Hinweise“, „Warnungen“, „Informationen“ und viele mehr. Richtig eingesetzt, können sie hilfreich sein – zwingend notwendig sind sie aber nicht.
  5. Fügt gerne an aus eurer Sicht wesentlichen Stellen Screenshots hinzu. Bedenkt jedoch: Jeder Screenshot muss bei einem Update erneuert werden, daher sollten sie wirklich nur für wichtige Abschnitte verwendet werden. Erweitert außerdem Erklärungen, wenn ihr merkt, dass die bestehenden Formulierungen nicht ausgereicht haben – vermutlich geht es auch anderen so.

Falls ihr Fragen zur Seitengestaltung dem Seiteneditor im Allgemeinen habt, meldet euch gerne bei mir via Webex (einfach nach Matthias Becker suchen) oder schreibt mir eine Mail an matthias.becker@hsbi.de

Klick mich, um zur Startseite des Wikis zu gelangen