Best Practice

Gruppierung von Inhalten

Inhalte bzw. Seiten sind grundsätzlich unabhängig vom Status ihrer Veröffentlichung im thematisch passenden Buch einzusortieren. Bücher dienen der Gruppierung von Inhalten, nicht, um Berechtigungen und Status der Veröffentlichung abzubilden. Seiten, die nur intern sichtbar sein sollen, sollen in einem Kapitel intern zusammengefasst werden.

Gliederung von Dokumenten

• Überschriften
  • gezielt und hierarchisch einsetzen
  • mit "Großer Überschrift" beginnen
  • keine Nummerierung
  • nicht als Fragen formulieren
    
  • max. 5 Wörter
• Standard: linksbündig mit notfalls sinnvoller Worttrennung
• Unnötige Leerzeilen vermeiden
• Vermeidung von Doppelformatierungen (z. B. fett formatierte Überschrift oder farbige Überschriften)
• Vermeidung von Tabellen (sind für mobile Darstellung ungeeignet)
• Vermeidung von unnötigen Leerzeilen (machen Seiten unnötig lang, zerstören Layout)
• mit geschützten Umbrüchen (Shift + Enter) lassen sich Zeilenumbrüche ohne neun Absatz bzw. ohne neuen Nummerierungs-/Listenpunkt erzeugen
  Hier ist
  Beispiel.
  https://www.computerkurs.com/word-kurs/zeilenumbruch-word/

Formulierungen

• Vermeidung von Abkürzungen, aber durchaus die gängigsten (z. B.; usw.) verwenden
  
• Vermeidung von redundanten Informationen
  Besser Inhalte verlinken. Jede Seite sollte mit einzigartigem Text überzeugen. Suchmaschinen Seiten mit redundantem Inhalt ab.
  
• Die Ansprache im Text lautet "Sie". Sollten Personengruppen genannt werden, dann bitte aufs Gendern achten:
  • Lehrende
  • Lernende
  • Kollegen
  • Nutzer

Textformatierung

Inhalte aus anderen Dokumenten übernehmen

Bei der Übernahme von Inhalten, insbesondere aus Word-, PDF-Dokumenten und Web-Seiten ist darauf zu achten, dass Inhalte ohne Formatierung übernommen werden. Nach dem Kopieren (Strg + C) sollen diese mit Strg + Shift + V eingefügt werden.

unnütze Umbrüche entfernen

Werden Inhalte aus Mails oder PDFs übernommen, werden Zeilenumbrüche mit übernommen. Zeilenumbrüche müssen entfernt und durch ein Leerzeichen ersetzt werden, damit der Textfluss gegeben ist.

Aus der PDF:

Hallo. Ich bin ein kleiner Blindtext. Und zwar[Umbruch]
schon so lange ich denken kann. Es war nicht[Umbruch]
leicht zu verstehen, was es bedeutet, ein blinder[Umbruch]
Text zu sein: Man ergibt keinen Sinn.

In Bookstack:

Hallo. Ich bin ein kleiner Blindtext. Und zwar[Leerzeichen]schon so lange ich denken kann. Es war nicht[Leerzeichen]leicht zu verstehen, was es bedeutet, ein blinder[Leerzeichen]Text zu sein: Man ergibt keinen Sinn.

Zudem sind vor und nach Überschriften keine Leerzeilen einzufügen:

Überschrift
[Leerzeile]
Hallo. Ich bin ein kleiner Blindtext.
[Leerzeile]
[Bild]
[Leerzeile]

Überschrift
Hallo. Ich bin ein kleiner Blindtext.
[Bild]

Verlinkungen

• Verlinkungen innerhalb der KB sind im gleichen, Verlinkungen externer Seiten in neuem Fenster zu öffnen; interne Verlinkungen können jederzeit per Rechtsklick Link in neuem Tab/Fenster öffnen geöffnet werden. Nutzer sollen die Wahl haben.
• zu Kontaktdaten verlinken:
  • https://kb.el.uni-leipzig.de/books/start/page/kontakt aufrufen
    
  • zur gewünschten Stelle scrollen
  • Überschrift markieren
  • Link aus Pop-up-Fenster kopieren und entsprechend einfügen
• Verlinkung zu einzelnem Abschnitt (auf einer Seite) oder einem Kapitel nutzen
  • Buch/Seite aufrufen, wo links das Inhaltsverzeichnis ist, Rechtsklick auf Titel und Link kopieren
• Shortcuts oben für (interne) Verlinkung nutzen Strg + Shift + K
  

Icons

🔗 https://www.urz.uni-leipzig.de/servicedesk-und-hilfe/kontakt-zum-servicedesk
📧 servicedesk@uni-leipzig.de
☎ +49 341 97-33333

▶️ Referat vs. Erklärfilm

Icons sind nur in Ausnahmefällen zu verwenden.

Ab hier geht es speziell um Erstellung von Anleitungen!

Anleitungen

• Was können Lehrende und Studierende damit machen? Für welche Lehr-Lern-Szenarien eignet sich die Aktivität? Beispiele: Reflexionsaufgaben, Kollaboratives Arbeiten, Vorwissenaktivierung, Einstieg ins Thema, etc.
• Zu Beginn stets auf die Grundanleitung zur Erstellung einer Aktivität verweisen: Anleitung zur Erstellung einer Aktivität 
• Der graue Bereich mit den einweisenden Erklärungen bleibt erhalten, aber ohne grauen Hintergrund. Der Verweis auf die Screenshots (dass sie aus Moodle stammen) entfällt.
  
• Dabei wird das Format Absatz verwendet. Der Text ist linksbündig zu halten.
• Eine generelle Nummerierung entfällt. Bei Stichpunkten sind nur die Buttons oben im Editor zu verwenden: 
  
• Screenshots, die nur auf das Klicken eines Buttons deuten, entfallen, um die Seite schlanker und kürzer zu halten. Dafür werden die Buttons mit dem Inline Code gekennzeichnet.

Nutzung von Anmerkungsfeldern und Inline Code

Achtung: Wird verwendet, um besonders wichtige Sachverhalte darzustellen

Tipp: Wird verwendet, um besonders hilfreiche Tipps darzustellen

Information: Wird verwendet, um zusätzliche Hinweise darzustellen

Wird im Text beschrieben, dass ein Button o. ä. angeklickt werden soll, dann diesen mit dem Inline Code kennzeichnen:

Im Tab Bewertung sehen Sie die Bewertungen. Klicken Sie auf Speichern und beenden. (Strg + 8)

Anhänge

Inhalte sollten nativ, d. h. direkt mit dem vorhandenen Editor, eingepflegt werden. Die Verwendung von Anhängen ist nicht zu empfehlen. Anhänge

• können nicht aktualisiert werden
• sind nicht durchsuchbar
• sind nicht barrierefrei
• können nicht im Browser betrachtet werden
• werden auf mobilen Geräten schlecht dargestellt

Bilder

• auf Auflösung achten (keine zu verpixelten Bilder)
  
• Bildbreite im 150er Pixelraster (Beispiel: 1x 150px, 2x 150px, ...)
• Alternativtext einfügen
• Formatierung:
  • linksbündig
  • keine Leerzeilen drüber/drunter
• bei Screenshots von Systemen:
  • Nutzendendaten schwärzen
  • Taskleisten entfernen
  • Markierungen und Pfeile sinnvoll einfügen über den Zeicheneditor in der KB

Anordnung und Gestaltung von Bildern

• Normale Texte werden über den zugehörigen Screenshot geschrieben. Texte sollten nicht neben Screenshots angeordnet werden, da dies die barrierefreie Nutzung einschränkt.
• Vor und nach Bildern werden keine Leerzeilen eingefügt.
• Zusätzlich muss darauf geachtet werden, dass Bilder nicht nebeneinander erscheinen, da dann nicht beide Alternativtexte vorgelesen werden. Dies beeinträchtigt die Barrierefreiheit.
• Screenshots/Bilder werden mit einem 1 Pt breiten schwarzen Rahmen umrandet:
  
  
• Erstellung eines Alternativ-Textes:
  
  
• Screenshot oder Bilder sollen mit dem Button Zeichnung einfügen/bearbeiten bearbeitet werden:
  
  
• Umrandung einzelner Menüpunkte: 
  
  
• Umrandung/Nummerierung mehrerer Menüpunkte in einem Bild:
  
  
• Kleine Pfeile zur Markierung mehrerer Menüpunkte in einem Bild:
  
  
• große Pfeile zur Markierung wichtiger Menüpunkte oder dem, was angeklickt werden soll: