Styleguide: Übersichtsartikel für Module: Unterschied zwischen den Versionen
Jaeger (Diskussion | Beiträge) |
|||
| (7 dazwischenliegende Versionen von einem anderen Benutzer werden nicht angezeigt) | |||
| Zeile 5: | Zeile 5: | ||
Modulartikel beginnen immer mit S3Modul-Bildlink:<br> | Modulartikel beginnen immer mit S3Modul-Bildlink:<br> | ||
<code><nowiki> | <code><nowiki> | ||
| − | [[Bild:Module.png|right|verweis=http://www.mauve. | + | [[Bild:Module.png|right|verweis=http://www.mauve.de/]] |
| − | </nowiki></code> | + | </nowiki></code><br><br> |
Danach kommt eine Table of Contents:<br> | Danach kommt eine Table of Contents:<br> | ||
<code><nowiki> | <code><nowiki> | ||
__TOC__ | __TOC__ | ||
| − | </nowiki></code> | + | </nowiki></code><br><br> |
Am Anfang gibt es einen kurzen einführenden Text. In diesem wird in zwei bis drei Sätzen erläutert, was das Modul macht und an welche Zielgruppe es sich richtet.<br> | Am Anfang gibt es einen kurzen einführenden Text. In diesem wird in zwei bis drei Sätzen erläutert, was das Modul macht und an welche Zielgruppe es sich richtet.<br> | ||
Sollten speziellere Vorbereitungen notwendig für die Nutzung des Moduls sein, wird ein entsprechender Bereich zusätzlich angegeben.<br> | Sollten speziellere Vorbereitungen notwendig für die Nutzung des Moduls sein, wird ein entsprechender Bereich zusätzlich angegeben.<br> | ||
Hierbei wird auf die entsprechenden Einstellungsdialog-Beschreibung verlinkt.<br> | Hierbei wird auf die entsprechenden Einstellungsdialog-Beschreibung verlinkt.<br> | ||
| − | Danach folgt ein Textbereich mit einer ausführlichen Beschreibung | + | Danach folgt ein Textbereich mit einer ausführlichen Beschreibung der Prozesse (Arbeitsabläufe) dieses Moduls. Ist der Arbeitsablauf umfangreicher ist es sinnvoll diesen mit einer Grafik zu visualisieren.<br> |
| + | Wenn mehrere verschiedene Prozesse vorhanden sind, wird für jeden Prozess ein eigener Unterpunkt angelegt.<br> | ||
| + | Ist die Prozessbeschreibung zu lang, wird dieser in einen entsprechenden [[Styleguide:_Artikel,_die_Prozesse_beschreiben|Prozessartikel]] ausgelagert.<br><br> | ||
Am Ende wird eine Fußzeile des Artikels (wie unter [[Styleguide:_Beschreibung_der_Oberfläche#Fu.C3.9Fzeilen|Einfache Darstellung/Fußzeilen]] beschrieben) eingefügt. Als Kategorie wird ''Modul'' angegeben.<br><br> | Am Ende wird eine Fußzeile des Artikels (wie unter [[Styleguide:_Beschreibung_der_Oberfläche#Fu.C3.9Fzeilen|Einfache Darstellung/Fußzeilen]] beschrieben) eingefügt. Als Kategorie wird ''Modul'' angegeben.<br><br> | ||
| − | |||
| − | |||
| + | =Beispiel= | ||
<code><nowiki> | <code><nowiki> | ||
| − | [[Bild:Module.png|right|verweis=http://www.mauve. | + | [[Bild:Module.png|right|verweis=http://www.mauve.de/]] |
</nowiki></code><br><code><nowiki> | </nowiki></code><br><code><nowiki> | ||
__TOC__ | __TOC__ | ||
| Zeile 40: | Zeile 41: | ||
</nowiki></code><br><br><code><nowiki> | </nowiki></code><br><br><code><nowiki> | ||
| − | =Arbeitsablauf= | + | =Prozesse= |
| + | </nowiki></code><br><code><nowiki> | ||
| + | ==Arbeitsablauf 1== | ||
| + | </nowiki></code><br><code><nowiki> | ||
| + | [[Bild:Arbeitsablauf1-Schema.png|right]] | ||
| + | </nowiki></code><br><code><nowiki> | ||
| + | Textbereich mit einer ausführlichen Beschreibung des Arbeitsablauf 1 | ||
| + | </nowiki></code><br><code><nowiki> | ||
| + | <br style="clear:both" /> | ||
| + | </nowiki></code><br><br><code><nowiki> | ||
| + | ==Arbeitsablauf 2== | ||
</nowiki></code><br><code><nowiki> | </nowiki></code><br><code><nowiki> | ||
| − | [[Bild: | + | [[Bild:Arbeitsablauf2-Schema.png|right]] |
</nowiki></code><br><code><nowiki> | </nowiki></code><br><code><nowiki> | ||
| − | Textbereich mit einer ausführlichen Beschreibung des | + | Textbereich mit einer ausführlichen Beschreibung des Arbeitsablauf 2 |
</nowiki></code><br><code><nowiki> | </nowiki></code><br><code><nowiki> | ||
<br style="clear:both" /> | <br style="clear:both" /> | ||
</nowiki></code><br><br><code><nowiki> | </nowiki></code><br><br><code><nowiki> | ||
| − | |||
[…] | […] | ||
</nowiki></code><br><br><code><nowiki> | </nowiki></code><br><br><code><nowiki> | ||
Fußzeile des Artikels (wie unter </nowiki></code>[[Styleguide:_Beschreibung_der_Oberfläche#Fu.C3.9Fzeilen|Einfache Darstellung/Fußzeilen]]<code><nowiki> beschrieben) | Fußzeile des Artikels (wie unter </nowiki></code>[[Styleguide:_Beschreibung_der_Oberfläche#Fu.C3.9Fzeilen|Einfache Darstellung/Fußzeilen]]<code><nowiki> beschrieben) | ||
| − | </nowiki></code><br><code><nowiki> | + | </nowiki></code><br><br><code><nowiki> |
[[Category:Module]] | [[Category:Module]] | ||
</nowiki></code> | </nowiki></code> | ||
Aktuelle Version vom 23. Juli 2019, 08:12 Uhr
Allgemeines
Modulartikel beginnen immer mit S3Modul-Bildlink:
[[Bild:Module.png|right|verweis=http://www.mauve.de/]]
Danach kommt eine Table of Contents:
__TOC__
Am Anfang gibt es einen kurzen einführenden Text. In diesem wird in zwei bis drei Sätzen erläutert, was das Modul macht und an welche Zielgruppe es sich richtet.
Sollten speziellere Vorbereitungen notwendig für die Nutzung des Moduls sein, wird ein entsprechender Bereich zusätzlich angegeben.
Hierbei wird auf die entsprechenden Einstellungsdialog-Beschreibung verlinkt.
Danach folgt ein Textbereich mit einer ausführlichen Beschreibung der Prozesse (Arbeitsabläufe) dieses Moduls. Ist der Arbeitsablauf umfangreicher ist es sinnvoll diesen mit einer Grafik zu visualisieren.
Wenn mehrere verschiedene Prozesse vorhanden sind, wird für jeden Prozess ein eigener Unterpunkt angelegt.
Ist die Prozessbeschreibung zu lang, wird dieser in einen entsprechenden Prozessartikel ausgelagert.
Am Ende wird eine Fußzeile des Artikels (wie unter Einfache Darstellung/Fußzeilen beschrieben) eingefügt. Als Kategorie wird Modul angegeben.
Beispiel
[[Bild:Module.png|right|verweis=http://www.mauve.de/]]
__TOC__
=Einführung=
Einleitender Text: Was macht das Modul? Für wen ist das Modul wichtig/interessant?
<br style="clear:both" />
=Vorausetzungen=
Spezielle Vorbereitungen (Freischaltung von Fremdanbietermodulen, Übermittlung von Zugangsdaten)
:''Hauptartikel: [[Einstellungen]]
<br style="clear:both" />
=Prozesse=
==Arbeitsablauf 1==
[[Bild:Arbeitsablauf1-Schema.png|right]]
Textbereich mit einer ausführlichen Beschreibung des Arbeitsablauf 1
<br style="clear:both" />
==Arbeitsablauf 2==
[[Bild:Arbeitsablauf2-Schema.png|right]]
Textbereich mit einer ausführlichen Beschreibung des Arbeitsablauf 2
<br style="clear:both" />
[…]
Fußzeile des Artikels (wie unter Einfache Darstellung/Fußzeilen beschrieben)
[[Category:Module]]
- Siehe auch