|
|
| (2 dazwischenliegende Versionen von einem anderen Benutzer werden nicht angezeigt) |
| Zeile 1: |
Zeile 1: |
| − | 1. Allgemeines = Kurzer Überblick über die beschriebene Funktion in einem Satz
| |
| | | | |
| − | inkl. Position = Wie gelange ich zu der Funktion innerhalb von TraiNex
| |
| − |
| |
| − | 2. Nutzen = Kurze Zusammenfassung, was diese Funktion der Bildungseinrichtung bringt
| |
| − | 3. Aufbau = Kurze und knappe Beschreibung der Benutzeroberfläche der jeweiligen Funktion
| |
| − |
| |
| − | 4. Funktionen = Ausführliche Beschreibung aller Aspekte, was man mit der Funktion machen kann
| |
| − |
| |
| − | mit ggf. Unterpunkten
| |
| − |
| |
| − |
| |
| − | 5. Profi-Tipps = Kurze Praxis-Ratschläge zur Nutzung der Funktion
| |
| − |
| |
| − | 6. Rechte: falls es Spezialrechte auf der Seite gibt, die irgendwie zu beachten/vergeben sind
| |
| − |
| |
| − | 7. Textbausteine: falls es Textbausteine gibt
| |
| − |
| |
| − | 8. Konfigurationsmöglichkeiten: falls es Schalter gibt, die TRON umstellen kann
| |
| − |
| |
| − | 9. Videos und sonstige Infos
| |
| − |
| |
| − | 10. siehe auch
| |
| − |
| |
| − | fraglich, ob wir nummerieren, denn wenn eine Nr. weg fällt, weil es den Bereich nicht gibt, dann wäre die Nr. 9 auf einmal die Nr. 8
| |
| − |
| |
| − |
| |
| − | 11 Schreib-Regeln für das Wiki
| |
| − | 1. An den Leser denken. Der Leser ist ein Mitarbeiter einer Hochschule, der ein TraiNex-Problem hat. Wir wollen dem Leser helfen, sein Problem zu lösen!
| |
| − | 2. 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.
| |
| − | 3. 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“.
| |
| − | 4. 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 …“
| |
| − | 5. Wir benutzen „können (optional)“ oder „sollten“ oder „müssen (zwingend)“. Oder Formulierungen wie „Tragen Sie im Feld ‚Startdatum’ das Beginndatum des Events ein’.
| |
| − | 6. Rechtschreibung, Grammatik und Zeichensetzung müssen stimmen.
| |
| − | 7. Aktiv ist besser als passiv. Verben sind besser als Substantive. (Statt „Die Verwendung ist anzuraten“ besser “Am besten verwenden Sie …“)
| |
| − | 8. Alte Artikel nicht einfach neu schreiben. Alte Artikel sind bereits durchdacht und sollten nur erweitert oder vorsichtig korrigiert/strukturiert werden.
| |
| − | 9. Wir verwenden Absätze, Überschriften, Bilder und bei längeren Absätzen Spiegelstriche, um den Artikel übersichtlich zu gestalten.
| |
| − | 10. Wir erklären erst allgemein und dann anhand eines konkreten Beispiels. Das Beispiel soll kurz, einfach und anschaulich verständlich sein.
| |
| − | 11. Wir verwenden ein Gestaltungsraster, ein Struktur-Raster und diese Schreib-Regeln.
| |
