3.5 KiB
3.5 KiB
Weiterentwicklung
Zentrale Arbeits- und Regeldatei fuer die Weiterentwicklung von desktop.kusche.berlin.
Diese Datei enthaelt:
- Go's und NoGo's
- Dokumentationsregeln
- Architektur- und Pflegehinweise
Dokumentationspflicht
Die Projektdokumentation wird zentral und dezentral gleichzeitig gepflegt.
Verbindlich ist:
- zentrale Inhalte und Begriffe muessen in CONTENT.md gepflegt werden
- Nutzungs- und Hilfetexte muessen in ANLEITUNG.md gepflegt werden
- Entwicklungsregeln muessen in dieser Datei gepflegt werden
- vorhandene
README.md-Dateien in Unterordnern muessen weiter gepflegt werden - wichtige Informationen aus den einzelnen
README.md-Dateien muessen auch zentral gehalten werden - bei neuen wichtigen Unterordnern ist zu pruefen, ob eine eigene
README.mdnoetig ist
Go's
- Desktop-Mechaniken zentral halten, nicht pro App duplizieren
- Fensterverhalten konsistent halten
- gemeinsame Standards fuer Fensterinhalte nutzen, sofern eine App kein bewusst eigenes UI benoetigt
- Begriffe in UI und Doku konsistent nach
CONTENT.mdverwenden - Apps als bereitgestellte Systemfunktionen denken, nicht nur als sichtbare Fenster
- Unterschiede zwischen
App,InfobereichundWidget-Bereichsauber trennen - lokale Persistenz und spaetere Backend-Synchronisierung getrennt vorbereiten
- Nutzerdaten und Desktop-Preferences bevorzugt datenbankbasiert speichern, nicht dateibasiert
README.md-Dateien in Teilbereichen aktuell halten- zentrale Doku bei jeder relevanten Struktur- oder Begriffsanpassung mitpflegen
NoGo's
- keine stillen Umbenennungen von Bereichen ohne Aktualisierung der zentralen Doku
- keine Rueckbauten bestehender Desktop-Mechaniken ohne ausdrueckliche Entscheidung
- keine Vermischung von Modul-Businesslogik mit globalem Desktop-Core
- keine Skin-Sonderlogik direkt in einzelnen Apps, wenn sie global loesbar ist
- keine nur lokalen README-Informationen ohne zentrale Uebernahme der wichtigen Punkte
- keine Hilfeinhalte nur in Chatverlaeufen oder Ad-hoc-Notizen belassen
- keine produktive Architekturabhaengigkeit zu
Old-Nexus/oder vergleichbaren Altbestaenden
Architekturregeln
modules/<modul>/bleibt Ort fuer klassische Module- globale Desktop-Mechaniken liegen im gemeinsamen Kern
- Skins definieren Darstellung und Interaktionsdetails, nicht die Fachlogik
- Hilfe- und Inhaltsdateien sollen spaeter maschinenlesbar oder zumindest klar strukturierbar in einen Hilfebereich ueberfuehrt werden koennen
Pflegeprozess
Bei jeder groesseren Aenderung ist zu pruefen:
- Wurden offizielle Begriffe geaendert oder erweitert
- Wurde der Systemumfang sichtbar erweitert
- Braucht ein Unterordner eine gepflegte
README.md - Muessen zentrale Dateien angepasst werden
- Ist der Inhalt spaeter fuer einen Hilfebereich relevant
Aktuell wichtige Projektregeln
UMSETZUNGSSTATUS.mdnur dann als erledigt markieren, wenn es ausdruecklich freigegeben wurde- Fokus liegt aktuell auf Desktop-UI und Apps
- Login und Keycloak sind vorerst akzeptiert und nicht der aktuelle Hauptschwerpunkt
- Desktop-Icons sind frei verschiebbar und werden pro Benutzer und Skin lokal gespeichert
- die Schriftfarbe von Desktop-Icons passt sich automatisch an den Hintergrund an
- Benutzerdaten sollen spaeter sauber in LDAP oder Keycloak geschrieben werden
- Standard-Fensterinhalte sollen ein gemeinsames Design nutzen
- Desktop-Nutzereinstellungen liegen in einer eigenen Tabelle mit erkennbarem
_user_data-Suffix