Skip to content
Code-Schnipsel Gruppen Projekte
Commit 07da2c28 erstellt von Patrick Müller's avatar Patrick Müller
Dateien durchsuchen

Update usage.md

Übergeordneter 29924521
No related branches found
No related tags found
1 Merge Request!1Dev
......@@ -42,6 +42,7 @@ Dokumentationen einzelner QUIQQER-Pakete werden grundsätzlich ins **Wiki** des
Die erste Seite des Wikis ist **immer gleich gegliedert**.
* Überschrift - beinhaltet den Namen des Pakets; dieser fängt üblicherweise mit "QUIQQER" oder "E-COYN" an.
* Bild - Das größte vorhandene Paket-Bild (i.d.R. der README-Header) sollte ganz oben platziert werden
* Features - beinhaltet eine **ausführliche** Feature-Liste des Pakets; dient auch als Grundlage für redaktionell erstellte Texte zum Funktionsumfang eines Pakets und sollte daher in **klaren, aussagekräftigen Sätzen** geschrieben werden.
* Benutzerhandbuch - beinhaltet einen kurzen Text, der zum Handbuch für **Endbenutzer** führt; sollte es sich um ein Plugin handeln, sollte in einem Satz erwähnt werden, dass es kein Benutzerhandbuch gibt.
* Dokumentation für Entwickler - beinhaltet eine Dokumentation für **Entwickler**, sofern das Modul eine API bietet; sollte es keine API geben, sollte das in einem kurzen Satz erwähnt werden.
......
0% oder .
You are about to add 0 people to the discussion. Proceed with caution.
Bearbeitung dieser Nachricht zuerst beenden!
Bitte registrieren oder zum Kommentieren