Kanbanize: HTML-Kommentar-Format und Pitfalls dokumentiert
This commit is contained in:
42
CLAUDE.md
42
CLAUDE.md
@@ -949,28 +949,34 @@ curl -H "apikey: $(cat ~/.config/kanbanize/token)" \
|
||||
|
||||
### Kommentar-Format für Problemdokumentation
|
||||
|
||||
```markdown
|
||||
## [Kurzbeschreibung des Problems]
|
||||
**WICHTIG: Kanbanize-Kommentare ignorieren `\n`-Zeilenumbrüche!**
|
||||
Formatierung MUSS über HTML-Tags erfolgen: `<br>` für Zeilenumbrüche, `<b>` für Fettschrift, ` ` für Einrückung.
|
||||
Die API gibt immer `type: plain` zurück, rendert aber trotzdem HTML.
|
||||
|
||||
**Datum:** YYYY-MM-DD
|
||||
**Bearbeiter:** Claude Code Session
|
||||
**Template (HTML):**
|
||||
|
||||
### Problem
|
||||
[Beschreibung des Problems/der Aufgabe]
|
||||
|
||||
### Durchgeführte Schritte
|
||||
1. [Schritt 1]
|
||||
2. [Schritt 2]
|
||||
...
|
||||
|
||||
### Ergebnis
|
||||
[Was wurde gelöst/geändert]
|
||||
|
||||
### Betroffene Systeme
|
||||
- [Host/Dienst 1]
|
||||
- [Host/Dienst 2]
|
||||
```html
|
||||
<b>[TITEL: Kurzbeschreibung]</b><br><br><b>PROBLEM</b><br>• [Punkt 1]<br>• [Punkt 2]<br><br><b>URSACHE</b><br>• [Ursache 1]<br>• [Ursache 2]<br><br><b>LÖSUNG</b><br>• [Maßnahme 1]<br>• [Maßnahme 2, mit Unterpunkten:]<br> ◦ [Detail 1]<br> ◦ [Detail 2]<br><br><b>BETROFFENE SYSTEME</b><br>• [Host/Dienst 1]<br>• [Host/Dienst 2]
|
||||
```
|
||||
|
||||
**Formatierungs-Regeln:**
|
||||
|
||||
| Element | HTML | Ergebnis |
|
||||
|---------|------|----------|
|
||||
| Zeilenumbruch | `<br>` | Neue Zeile |
|
||||
| Leerzeile | `<br><br>` | Absatz |
|
||||
| Fettschrift | `<b>Text</b>` | **Text** |
|
||||
| Einrückung | ` ` | 4 Leerzeichen |
|
||||
| Aufzählung | `• Text` (Unicode U+2022) | • Text |
|
||||
| Unter-Aufzählung | `◦ Text` (Unicode U+25E6) | ◦ Text |
|
||||
|
||||
### Pitfalls
|
||||
|
||||
- **Kommentare können nicht via API gelöscht werden** (Permission Error) — nur über die UI
|
||||
- **`\n` wird komplett ignoriert** — immer `<br>` verwenden
|
||||
- **Markdown wird NICHT gerendert** — kein `##`, `**`, `-` etc.
|
||||
- **`type` ist immer `plain`** — kann nicht auf `html` gesetzt werden, HTML wird trotzdem gerendert
|
||||
|
||||
### In die Task-Abschluss-Checkliste integriert
|
||||
|
||||
Bei Vinos-Arbeiten wird die Kanbanize-Prüfung Teil der Pflicht-Checkliste:
|
||||
|
||||
Reference in New Issue
Block a user