Konventionen
Ich verwende in der Dokumentation einige Konventionen, die vielleicht für einige Leser ungewöhnlich sind. Deshalb hier an einer Stelle aufgeführt, mit einer kurzen Erklärung.
| Beispiel | Begriff | Erklärung |
|---|---|---|
| Aufgaben | Link | Verweist entweder auf einen anderen Teil der Dokumentation oder auf ein externes System. Wenn man darauf klickt, öffnet sich ein neuer Tab. |
| Spiel > Analyse > Studie | Menufolge | Man findet in der aktuellen Oberfläche den Button oder Link "Spiel", wenn man den auswählt, den Button "Analyse", dann "Studie". Ist einfach eine Kurzschreibweise, wie man schnell zu etwas kommt. Manchmal muss man ein wenig überlegen, was damit gemeint ist. |
| Studie importieren: XXX | Erklärung | Oft gibt es Listen, in denen kurz etwas vorgestellt werden soll. Es beginnt mit dem Begriff, dann kommt die Erläuterung. Alternativ könnte auch eine Tabelle mit 2 Spalten verwendet werden. |
| <Einrücklisten> | Thema mit Unterthemen | Wenn ich etwas thematisch zusammenfassen möchte, mache ich auf erster Ebene ein Thema auf, auf der zweiten Ebene dann Teile du genau dem Thema. |