Wiki-Gestaltung: Unterschied zwischen den Versionen
Aus TraiNexWiki
Sbiele (Diskussion | Beiträge) (→Bildschirmfotos/Grafiken) |
Viola (Diskussion | Beiträge) (→Schreib-Regeln für das Wiki) |
||
| (18 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt) | |||
| Zeile 7: | Zeile 7: | ||
=== Pflicht-Elemente === | === Pflicht-Elemente === | ||
| − | * Allgemeines = Kurzer Überblick über die beschriebene Funktion in einem Satz, inkl. Position = Wie gelange ich zu der Funktion innerhalb von TraiNex | + | * Allgemeines = Kurzer Überblick über die beschriebene Funktion in einem Satz, inkl. Position = Wie gelange ich zu der Funktion innerhalb von TraiNex.<BR> |
| + | (Beispiel: Unter Admin//Anmeldung findet sich die Funktion zur Erstellung und Verwaltung von Anmeldung, Bestellungen und Bestätigungen.) | ||
* Nutzen = Kurze Zusammenfassung, was diese Funktion der Bildungseinrichtung bringt | * Nutzen = Kurze Zusammenfassung, was diese Funktion der Bildungseinrichtung bringt | ||
* Aufbau und Funktionen = Kurze und knappe Beschreibung der Benutzeroberfläche der jeweiligen Funktion sowie Beschreibung aller Aspekte, was man mit der Funktion machen kann | * Aufbau und Funktionen = Kurze und knappe Beschreibung der Benutzeroberfläche der jeweiligen Funktion sowie Beschreibung aller Aspekte, was man mit der Funktion machen kann | ||
| Zeile 13: | Zeile 14: | ||
=== Bedarfs-Elemente === | === Bedarfs-Elemente === | ||
| − | * | + | * Sonderfunktion: Falls es Spezialrechte auf der Seite gibt, die irgendwie zu beachten/vergeben sind, siehe auch [[Sonderfunktion]] |
| − | * Textbausteine: | + | * Textbausteine: Falls es Textbausteine gibt, siehe auch [[Textbaustein]] |
| − | * Konfigurationsparameter: | + | * Konfigurationsparameter: Falls es Schalter gibt, die [[TRON]] umstellen kann, siehe auch [[Konfiguration]] |
| − | * Profi-Tipps | + | * Profi-Tipps: Kurze Praxis-Ratschläge zur Nutzung der Funktion |
| − | * Videos und sonstige Infos | + | * Didaktische Anregungen: Falls es in der Lehre eingesetzt werden kann, z.B. bei Foren, MC-Tests |
| − | * siehe auch | + | * Videos, Aufsätze und sonstige Infos |
| + | * Bekannte Probleme | ||
| + | * Häufig gestellte Fragen (FAQ) | ||
| + | * Letzte funktionale Änderungen | ||
| + | * siehe auch: Verweise auf andere Wiki-Artikel | ||
=== Bildschirmfotos/Grafiken === | === Bildschirmfotos/Grafiken === | ||
| − | *Bildschirmfotos oder Grafiken sind Bildelemente | + | *Bildschirmfotos oder Grafiken sind Bildelemente. |
| − | *Bildelemente sollten zur Unterstützung der Erklärung angefertigt werden | + | *Bildelemente sollten zur Unterstützung der Erklärung angefertigt werden. |
| − | * | + | *Möglichst direkt in einer Auflösung snippen, die anschließend wiki-tauglich ist. |
*Gestaltungsraster: Bildelemente werden rechtsbündig eingebunden. Große Bildelemente haben eine Bildunterschrift. Kleine Bildelemente dürfen auch im Text integriert sein. | *Gestaltungsraster: Bildelemente werden rechtsbündig eingebunden. Große Bildelemente haben eine Bildunterschrift. Kleine Bildelemente dürfen auch im Text integriert sein. | ||
| − | * | + | *In dem Bildelement kann mit Markierungen auf wichtige Bereiche hingewiesen werden. |
| − | * | + | *Bei Bildschirmfotos ggf. datenschutzrelevante Teile schwärzen |
| − | *Grafiken sind ggf. systematische Pfeildiagramme oder sonstige erklärende Systematisierungen | + | *Im Bildelement, z.B. dem Snip eines TraiNex-Formulars, soll nicht ein leeres Formular dargestellt werden, sondern immer sinnige Textbeispiele aufgenommen werden. |
| + | *Grafiken sind ggf. systematische Pfeildiagramme oder sonstige erklärende Systematisierungen. | ||
| + | |||
| + | == Gendergerechte Sprache == | ||
| + | Im Wiki wird möglichst gendergerecht, aber trotzdem kurz und eindeutig geschrieben. Wir verwenden neutrale Begriffe wie "Mitarbeitende" statt "Mitarbeiter/Mitarbeiterin" oder substantivierte Partizipativformen. Wenn aus Gründen der besseren Lesbarkeit das generische Maskulinum verwendet werden sollte, dann sind weibliche und anderweitige Geschlechteridentitäten ausdrücklich mitgemeint, soweit es für die Aussage erforderlich ist. Mehr unter [[Gender]]. | ||
== Schreib-Regeln für das Wiki == | == Schreib-Regeln für das Wiki == | ||
| − | # An den Leser denken. Der Leser ist ein | + | # An den Leser denken. Der Leser ist ein Mitarbeitender einer Hochschule, der ein TraiNex-Problem hat. Wir wollen dem Leser helfen, sein Problem zu lösen! |
| − | # Der Inhalt muss kurz und knapp, aber trotzdem eindeutig und verständlich zusammengefasst werden. Die Absätze sind weder zu lang noch zu kurz. Nur ein Gedanke pro Satz. | + | # Der Inhalt muss kurz und knapp, aber trotzdem eindeutig und verständlich zusammengefasst werden. Die Absätze sind weder zu lang noch zu kurz. Nur ein Gedanke pro Satz. Faustregel: Nur maximal ein Nebensatz. |
| − | # Wir schreiben präzise, nicht umgangssprachlich und verwenden einheitliche Begriffe. TraiNex-Begriffe wie Feldnamen oder Buttons oder Module werden in Anführungszeichen gesetzt, um die Lesbarkeit zu erhöhen. Beispiel: | + | # Wir schreiben präzise, nicht umgangssprachlich und verwenden einheitliche Begriffe. TraiNex-Begriffe wie Feldnamen oder Buttons oder Module werden in Anführungszeichen gesetzt, um die Lesbarkeit zu erhöhen. Beispiel: Das Feld „Verfalldatum“ oder der Button „Einstellen“. |
| − | # Den Leser ansprechen: Wir benutzen „Sie“ oder ausnahmsweise „man“, z.B. „In der Infozeile sollten Sie einen aussagekräftigen Betreff | + | # Immer nur das beschreiben, worum es in dem Artikel geht. Angrenzende Themenbereiche nicht nochmals neu beschreiben, sondern nur mit einem Link im Text erwähnen. |
| − | # Wir benutzen „können (optional)“ oder „sollten“ oder „müssen (zwingend)“. Oder Formulierungen wie „Tragen Sie im Feld ‚Startdatum’ das Beginndatum des Events | + | # Den Leser ansprechen: Wir benutzen „Sie“ oder ausnahmsweise „man“, z.B. „In der Infozeile sollten Sie einen aussagekräftigen Betreff verwenden“ oder „Als Administrator sollten Sie …“ |
| + | # Wir benutzen „können (optional)“ oder „sollten“ oder „müssen (zwingend)“. Oder Formulierungen wie „Tragen Sie im Feld ‚Startdatum’ das Beginndatum des Events ein." | ||
# Rechtschreibung, Grammatik und Zeichensetzung müssen stimmen. | # Rechtschreibung, Grammatik und Zeichensetzung müssen stimmen. | ||
# Aktiv ist besser als passiv. Verben sind besser als Substantive. (Statt „Die Verwendung ist anzuraten“ besser “Am besten verwenden Sie …“) | # Aktiv ist besser als passiv. Verben sind besser als Substantive. (Statt „Die Verwendung ist anzuraten“ besser “Am besten verwenden Sie …“) | ||
# Alte Artikel nicht einfach neu schreiben. Alte Artikel sind bereits durchdacht und sollten nur erweitert oder vorsichtig korrigiert/strukturiert werden. | # Alte Artikel nicht einfach neu schreiben. Alte Artikel sind bereits durchdacht und sollten nur erweitert oder vorsichtig korrigiert/strukturiert werden. | ||
| + | # Vor einer Text-Erweiterung den kompletten Artikel lesen und verstehen. Nach einer Erweiterung nochmals die Text-Erweiterung lesen. | ||
# Wir verwenden Absätze, Überschriften, Bilder und bei längeren Absätzen Spiegelstriche, um den Artikel übersichtlich zu gestalten. | # Wir verwenden Absätze, Überschriften, Bilder und bei längeren Absätzen Spiegelstriche, um den Artikel übersichtlich zu gestalten. | ||
| − | # Wir erklären erst allgemein und dann anhand eines konkreten Beispiels. Das Beispiel soll kurz, einfach und anschaulich verständlich sein. | + | # Wir erklären erst allgemein und dann anhand eines konkreten Beispiels. Das Beispiel soll kurz, einfach und anschaulich verständlich sein. Das Beispiel soll positiv und eher zeitlos (ohne Jahresnennung) sein. Beispiel: "Exkursion zur Gartenmesse in Mailand im April" anstatt "Exkursion zur CeBIX-Innovation-Messe in Posemuckel am 21.3.2012 um 9 Uhr". |
| − | # Wir verwenden ein Gestaltungsraster, ein | + | # Bilder werden durchnummeriert. Im Bild wird markiert, welcher Bereich erklärt wird, z.B. mit einem gelben Rahmen. Im Text wird Bezug genommen auf die Abbildung mit "(siehe Abb.3)". Bilder sollen ebenfalls ein sinnvolles Beispiel sein, also nicht ausgefüllt sein mit "test" oder "123" oder "xyz", sondern einem konkreten nachvollziehbaren einfachen Beispiel. |
| + | # Wir verwenden ein Gestaltungsraster, ein Strukturraster und diese Schreib-Regeln. | ||
Aktuelle Version vom 9. November 2021, 15:48 Uhr
Auf dieser Seite werden alle internen Gestaltungsregeln für das TraiNex-Wiki gesammelt.
Inhaltsverzeichnis
Strukturraster
Alle neuen Wiki-Einträge sollten nach dem folgenden Muster aufgebaut sein.
Pflicht-Elemente
- Allgemeines = Kurzer Überblick über die beschriebene Funktion in einem Satz, inkl. Position = Wie gelange ich zu der Funktion innerhalb von TraiNex.
(Beispiel: Unter Admin//Anmeldung findet sich die Funktion zur Erstellung und Verwaltung von Anmeldung, Bestellungen und Bestätigungen.)
- Nutzen = Kurze Zusammenfassung, was diese Funktion der Bildungseinrichtung bringt
- Aufbau und Funktionen = Kurze und knappe Beschreibung der Benutzeroberfläche der jeweiligen Funktion sowie Beschreibung aller Aspekte, was man mit der Funktion machen kann
Bedarfs-Elemente
- Sonderfunktion: Falls es Spezialrechte auf der Seite gibt, die irgendwie zu beachten/vergeben sind, siehe auch Sonderfunktion
- Textbausteine: Falls es Textbausteine gibt, siehe auch Textbaustein
- Konfigurationsparameter: Falls es Schalter gibt, die TRON umstellen kann, siehe auch Konfiguration
- Profi-Tipps: Kurze Praxis-Ratschläge zur Nutzung der Funktion
- Didaktische Anregungen: Falls es in der Lehre eingesetzt werden kann, z.B. bei Foren, MC-Tests
- Videos, Aufsätze und sonstige Infos
- Bekannte Probleme
- Häufig gestellte Fragen (FAQ)
- Letzte funktionale Änderungen
- siehe auch: Verweise auf andere Wiki-Artikel
Bildschirmfotos/Grafiken
- Bildschirmfotos oder Grafiken sind Bildelemente.
- Bildelemente sollten zur Unterstützung der Erklärung angefertigt werden.
- Möglichst direkt in einer Auflösung snippen, die anschließend wiki-tauglich ist.
- Gestaltungsraster: Bildelemente werden rechtsbündig eingebunden. Große Bildelemente haben eine Bildunterschrift. Kleine Bildelemente dürfen auch im Text integriert sein.
- In dem Bildelement kann mit Markierungen auf wichtige Bereiche hingewiesen werden.
- Bei Bildschirmfotos ggf. datenschutzrelevante Teile schwärzen
- Im Bildelement, z.B. dem Snip eines TraiNex-Formulars, soll nicht ein leeres Formular dargestellt werden, sondern immer sinnige Textbeispiele aufgenommen werden.
- Grafiken sind ggf. systematische Pfeildiagramme oder sonstige erklärende Systematisierungen.
Gendergerechte Sprache
Im Wiki wird möglichst gendergerecht, aber trotzdem kurz und eindeutig geschrieben. Wir verwenden neutrale Begriffe wie "Mitarbeitende" statt "Mitarbeiter/Mitarbeiterin" oder substantivierte Partizipativformen. Wenn aus Gründen der besseren Lesbarkeit das generische Maskulinum verwendet werden sollte, dann sind weibliche und anderweitige Geschlechteridentitäten ausdrücklich mitgemeint, soweit es für die Aussage erforderlich ist. Mehr unter Gender.
Schreib-Regeln für das Wiki
- An den Leser denken. Der Leser ist ein Mitarbeitender einer Hochschule, der ein TraiNex-Problem hat. Wir wollen dem Leser helfen, sein Problem zu lösen!
- Der Inhalt muss kurz und knapp, aber trotzdem eindeutig und verständlich zusammengefasst werden. Die Absätze sind weder zu lang noch zu kurz. Nur ein Gedanke pro Satz. Faustregel: Nur maximal ein Nebensatz.
- Wir schreiben präzise, nicht umgangssprachlich und verwenden einheitliche Begriffe. TraiNex-Begriffe wie Feldnamen oder Buttons oder Module werden in Anführungszeichen gesetzt, um die Lesbarkeit zu erhöhen. Beispiel: Das Feld „Verfalldatum“ oder der Button „Einstellen“.
- Immer nur das beschreiben, worum es in dem Artikel geht. Angrenzende Themenbereiche nicht nochmals neu beschreiben, sondern nur mit einem Link im Text erwähnen.
- Den Leser ansprechen: Wir benutzen „Sie“ oder ausnahmsweise „man“, z.B. „In der Infozeile sollten Sie einen aussagekräftigen Betreff verwenden“ oder „Als Administrator sollten Sie …“
- Wir benutzen „können (optional)“ oder „sollten“ oder „müssen (zwingend)“. Oder Formulierungen wie „Tragen Sie im Feld ‚Startdatum’ das Beginndatum des Events ein."
- Rechtschreibung, Grammatik und Zeichensetzung müssen stimmen.
- Aktiv ist besser als passiv. Verben sind besser als Substantive. (Statt „Die Verwendung ist anzuraten“ besser “Am besten verwenden Sie …“)
- Alte Artikel nicht einfach neu schreiben. Alte Artikel sind bereits durchdacht und sollten nur erweitert oder vorsichtig korrigiert/strukturiert werden.
- Vor einer Text-Erweiterung den kompletten Artikel lesen und verstehen. Nach einer Erweiterung nochmals die Text-Erweiterung lesen.
- Wir verwenden Absätze, Überschriften, Bilder und bei längeren Absätzen Spiegelstriche, um den Artikel übersichtlich zu gestalten.
- Wir erklären erst allgemein und dann anhand eines konkreten Beispiels. Das Beispiel soll kurz, einfach und anschaulich verständlich sein. Das Beispiel soll positiv und eher zeitlos (ohne Jahresnennung) sein. Beispiel: "Exkursion zur Gartenmesse in Mailand im April" anstatt "Exkursion zur CeBIX-Innovation-Messe in Posemuckel am 21.3.2012 um 9 Uhr".
- Bilder werden durchnummeriert. Im Bild wird markiert, welcher Bereich erklärt wird, z.B. mit einem gelben Rahmen. Im Text wird Bezug genommen auf die Abbildung mit "(siehe Abb.3)". Bilder sollen ebenfalls ein sinnvolles Beispiel sein, also nicht ausgefüllt sein mit "test" oder "123" oder "xyz", sondern einem konkreten nachvollziehbaren einfachen Beispiel.
- Wir verwenden ein Gestaltungsraster, ein Strukturraster und diese Schreib-Regeln.
