Self-Assessment Format
Referenz des Markdown-Kommentarblock-Formats für Self-Assessment-Fragen.
Aktivierung
Das Self-Assessment muss per CLI-Flag oder CI-Input aktiviert werden:
Kommentarblock-Syntax
Fragen werden als HTML-Kommentarblock in Markdown-Dateien eingebettet. Der Block wird im Web nicht als Text angezeigt, sondern zur Build-Zeit extrahiert.
Struktur
Kommentarblock
| Element | Syntax | Beschreibung |
|---|---|---|
| Öffnung | <!---Self Assessment: | Muss mit Self Assessment: beginnen |
| Schließung | ---> | Schließt den Block |
Pro Markdown-Datei können mehrere Kommentarblöcke enthalten sein.
Hauptfrage
###### Fragetext? [Tag] ######
| Teil | Beschreibung |
|---|---|
###### | Überschrift Level 6 (öffnend und schließend) |
| Fragetext | Die Hauptfrage |
[Tag] | Kategorie-Tag in eckigen Klammern |
Unterfragen (Ebene 1)
1. Fragetext? [Tag]
| Teil | Beschreibung |
|---|---|
| 1 Leerzeichen Einrückung | Kennzeichnet Ebene 1 |
| Nummerierung | 1., 2., etc. |
[Tag] | Kategorie-Tag, kann leer sein [] |
Detailfragen (Ebene 2)
1. Fragetext? [Tag]
| Teil | Beschreibung |
|---|---|
| 5+ Leerzeichen Einrückung | Kennzeichnet Ebene 2 |
| Nummerierung | 1., 2., etc. |
[Tag] | Kategorie-Tag, kann leer sein [] |
Kontext-Metadaten
Der Parser extrahiert zusätzlich Kontext aus der umgebenden Markdown-Datei:
| Metadatum | Quelle | Syntax |
|---|---|---|
specTitle | Überschrift Level 4 | #### SPEC-01 Titel der Spezifikation |
specId | Überschrift Level 5 | ##### ID: SPEC-01-A |
specPreview | Überschrift Level 6 | ###### Vorschautext |
specImplications | Abschnitt | **Implikationen** gefolgt von nummerierter Liste bis <!---DirectiveTextEnd---> |
Build-Ausgabe
questions.json
Alle extrahierten Fragen werden zu public/questions.json zusammengefasst:
Self-Assessment-Seite
Die CLI generiert automatisch eine self-assessment.mdx-Seite, die:
questions.jsonlädt- Die
<SelfAssessment />-Komponente rendert - Im Header-Menü als eigene Seite (
type: "page",layout: "raw") erscheint
Fragentyp
Aktuell werden alle Detailfragen als Typ YesNo behandelt.