DE_Status der Handbuchseiten - siduction/sidu-manual GitHub Wiki
Status der Handbuchseiten
Am Anfang der neu erstellten Markdown-Dateien befindet sich im "INFOBEREICH FÜR DIE AUTOREN" ein Vermerk mit dem RC-Status.
Wir verwenden die Stufen RC1 - RC3.
Bereits veröffentlichte Dateien, oder solche, die im nächsten Release veröffentlicht werden, erhalten eine vorangestellte vierstellig Ziffer und der "INFOBEREICH FÜR DIE AUTOREN" wird entfernt.
Bitte die Datei DE_Home.md lesen!
RC Definition
- RC1:
- Inhalte aktualisiert, veraltete entfernt, neue hinzugefügt, Reihenfolge ggf. angepasst.
- Externe Links geprüft und aktualisiert.
- Interne Links auf "datei_de.md" aktualisiert. Sie werden bei der Veröffentlichung mittels Script auf ".html" umgestellt.
- Layout bearbeiten. Titel, Überschriftenhirarchie, Verwendung der drei inline span-Bereiche, Inhaltsverzeichnis, Listen, Tabellen.
- RC2:
Der Status wird erreicht wenn die nachfolgenden Punkte erfolgreich durchlaufen wurden. Bei Verbesserungsbedarf im "INFOBEREICH FÜR DIE AUTOREN" einen entsprechenden Vermerk mit Datum eintragen und in RC1 belassen.- Inhalte durch eine sachkundige Person prüfen.
- Rechtschreibprüfung.
- Layout prüfen.
- RC3:
Dies ist der unmittelbare Veröffentlichungskandidat. Fehler entweder sofort berichtigen, oder bei umfangreicheren Arbeiten mit entsprechendem Vermerk nach RC1 zurückstufen.- Inhalte durch eine zweite, sachkundige Person prüfen.
- Abschließend Layout, Rechtschreibung und alle Links prüfen.
Sonstiges
Der spezielle CSS-Code für code- und span-Bereiche ist auf github nicht verfügbar. Der Test des Layout sollte daher lokal auf dem eigenen PC mit den in DE_Home beschriebenen Einstellungen erfolgen.
Um ein möglichst gleichmäßiges Layout zu erreichen, bei der Verwendung des MD-Code bitte auch die Erläuterungen in DE_Home beachten.
Aktualisiert: 2022-12-26
Wenn eine Datei bearbeitet wird, bitte den RC-Status und den Namen eintragen.