57 lines
2 KiB
Markdown
57 lines
2 KiB
Markdown
# Prompt: Dokumentation synchronisieren
|
||
|
||
Verwende diesen Prompt wenn CSS-Code geändert wurde ohne gleichzeitige Doku-Aktualisierung,
|
||
oder wenn du prüfen willst ob Code und Dokumentation konsistent sind.
|
||
|
||
---
|
||
|
||
## Vorbereitung
|
||
|
||
Bestimme den Umfang der Drift:
|
||
- Nur eine Komponente betroffen → ab Schritt 2
|
||
- Mehrere Komponenten oder tiefgreifende Änderung → Schritte 1–6 vollständig durchlaufen
|
||
|
||
---
|
||
|
||
## Checkliste
|
||
|
||
### 1. Drift ermitteln
|
||
- Welche Klassen/Tokens existieren in CSS aber fehlen in `SKILL.md` oder `references/components.md`?
|
||
- Welche Doku-Einträge beschreiben Klassen, die in `components.css` nicht mehr existieren?
|
||
- Welche Funktionen sind in `base.css` vorhanden aber fehlen in der JS-API-Tabelle in `README.md`?
|
||
|
||
### 2. `.opencode/skills/SKILL.md` aktualisieren
|
||
- Neue Klassen in der passenden Kategorie als Schnellreferenz ergänzen
|
||
- Entfernte Klassen löschen
|
||
- Varianten-Kommentare aktuell halten (max. 5–8 Zeilen pro Komponente)
|
||
|
||
### 3. `.opencode/skills/references/components.md` aktualisieren
|
||
- Vollständige Beispiele auf aktuellen Stand bringen
|
||
- Alle Varianten und Modifier vorhanden und korrekt?
|
||
- Beispiele müssen direkt kopierbar sein
|
||
|
||
### 4. `README.md` aktualisieren
|
||
- Öffentliche Dokumentation spiegelt den aktuellen Code-Stand
|
||
- Keine Features dokumentieren die nicht existieren
|
||
- Bei JS-Änderungen: JS-API-Tabelle synchronisieren
|
||
|
||
### 5. `index.html` prüfen
|
||
- Demo-Abschnitte reflektieren aktuellen Stand?
|
||
- Veraltete Klassennamen in der Demo ersetzen
|
||
- Fehlende Varianten ergänzen
|
||
|
||
### 6. `REPO_MAP.md` prüfen
|
||
- Komponenten-Übersicht vollständig und aktuell?
|
||
- Neue oder entfernte Komponenten eintragen bzw. löschen
|
||
|
||
---
|
||
|
||
## Erlaubte Abkürzungen
|
||
|
||
- Nur ein neuer Modifier ergänzt: Schritte 4–6 können auf eine Zeile reduziert werden
|
||
- Reine Umbenennung einer CSS-Custom-Property: `tokens.md` statt `components.md` aktualisieren
|
||
|
||
## Nicht erlaubt
|
||
|
||
- `README.md` auf einem anderen Stand als `components.css`
|
||
- Doku-Einträge für Klassen, die im CSS nicht existieren
|