Agent-almanac review-skill-format
git clone https://github.com/pjt222/agent-almanac
T=$(mktemp -d) && git clone --depth=1 https://github.com/pjt222/agent-almanac "$T" && mkdir -p ~/.claude/skills && cp -r "$T/i18n/de/skills/review-skill-format" ~/.claude/skills/pjt222-agent-almanac-review-skill-format-9e8156 && rm -rf "$T"
i18n/de/skills/review-skill-format/SKILL.mdSkill-Format pruefen
Eine SKILL.md-Datei gegen den agentskills.io-Standard validieren. Dieser Skill prueft Vollstaendigkeit der YAML-Frontmatter, Vorhandensein erforderlicher Abschnitte, Format der Vorgehensweisenschritte (Erwartet/Bei-Fehler-Blocks), Zeilenzahlbeschraenkungen und Registry-Synchronisierung. Vor dem Merge jedes neuen oder geaenderten Skills anwenden.
Wann verwenden
- Ein neuer Skill wurde verfasst und braucht Formatvalidierung vor dem Merge
- Ein bestehender Skill wurde geaendert und braucht Revalidierung
- Chargenauditierung aller Skills einer Domain durchfuehren
- Einen vom
-Meta-Skill erstellten Skill verifizierencreate-skill - Die Skill-Einreichung eines Mitwirkenden in einem Pull Request pruefen
Eingaben
- Erforderlich: Pfad zur SKILL.md-Datei (z.B.
)skills/setup-vault/SKILL.md - Optional: Strenge-Stufe (
odernachsichtig
, Standard:streng
)streng - Optional: Ob Registry-Synchronisierung geprueft werden soll (Standard: ja)
Vorgehensweise
Schritt 1: Datei verifizieren und Inhalt lesen
Bestaetigen dass die SKILL.md-Datei am erwarteten Pfad existiert und ihren gesamten Inhalt lesen.
# Dateiexistenz verifizieren test -f skills/<skill-name>/SKILL.md && echo "EXISTIERT" || echo "FEHLT" # Zeilen zaehlen wc -l < skills/<skill-name>/SKILL.md
Erwartet: Datei existiert und Inhalt ist lesbar. Zeilenzahl wird angezeigt.
Bei Fehler: Wenn die Datei nicht existiert, den Pfad auf Tippfehler pruefen. Verifizieren dass das Skill-Verzeichnis existiert mit
ls skills/<skill-name>/. Wenn das Verzeichnis fehlt, wurde der Skill noch nicht erstellt -- zuerst create-skill verwenden.
Schritt 2: YAML-Frontmatter-Felder pruefen
Den YAML-Frontmatter-Block (zwischen
----Begrenzern) parsen und verifizieren dass alle erforderlichen und empfohlenen Felder vorhanden sind.
Erforderliche Felder:
-- stimmt mit Verzeichnisname ueberein (Kebab-Case)name
-- unter 1024 Zeichen, beginnt mit einem Verbdescription
-- typischerweiselicenseMIT
-- komma- oder leerzeichengetrennte Werkzeuglisteallowed-tools
Empfohlene Metadatenfelder:
-- Autorennamemetadata.author
-- semantische Versionszeichenkettemetadata.version
-- eine der inmetadata.domain
aufgefuehrten Domainsskills/_registry.yml
-- eine von:metadata.complexity
,basic
,intermediateadvanced
-- Primaersprache odermetadata.languagemulti
-- kommagetrennt, 3-6 Tags, enthaelt Domaennamemetadata.tags
# Erforderliche Frontmatter-Felder pruefen head -30 skills/<skill-name>/SKILL.md | grep -q '^name:' && echo "name: OK" || echo "name: FEHLT" head -30 skills/<skill-name>/SKILL.md | grep -q '^description:' && echo "description: OK" || echo "description: FEHLT" head -30 skills/<skill-name>/SKILL.md | grep -q '^license:' && echo "license: OK" || echo "license: FEHLT" head -30 skills/<skill-name>/SKILL.md | grep -q '^allowed-tools:' && echo "allowed-tools: OK" || echo "allowed-tools: FEHLT"
Erwartet: Alle vier erforderlichen Felder vorhanden. Alle sechs Metadatenfelder vorhanden.
name stimmt mit Verzeichnisname ueberein. description ist unter 1024 Zeichen.
Bei Fehler: Jedes fehlende Feld als BLOCKIEREND melden. Wenn
name nicht mit dem Verzeichnisnamen uebereinstimmt, als BLOCKIEREND mit dem erwarteten Wert melden. Wenn description 1024 Zeichen ueberschreitet, als VORSCHLAG mit aktueller Laenge melden.
Step 3: Locale-Specific Validation (Translations Only)
If the frontmatter contains a
locale field, the file is a translated SKILL.md. Perform these additional checks. If no locale field is present, skip this step.
-
Translation frontmatter fields — Verify these five fields are present:
— target locale code (e.g.,locale
,de
,ja
,zh-CN
)es
— origin locale (typicallysource_locale
)en
— commit hash of the English source used for translationsource_commit
— who or what produced the translationtranslator
— ISO 8601 date of translationtranslation_date
-
Prose language scan — Sample 3-5 body paragraphs (outside code blocks, frontmatter, and headings). Verify the prose is written in the target locale, not English.
-
Code block identity check — Compare code blocks in the translated file against the English source. Code blocks must be identical (code is never translated).
Expected: All five translation fields present. Body paragraphs are in the target locale. Code blocks match the English source exactly.
On failure: Report missing translation fields as BLOCKING. If body paragraphs are in English despite a non-English
locale, report as BLOCKING.
Schritt 7: Erforderliche Abschnitte pruefen
Verifizieren dass alle sechs erforderlichen Abschnitte im Skill-Koerper vorhanden sind (nach Frontmatter).
Erforderliche Abschnitte:
## Wann verwenden## Eingaben
(mit## Vorgehensweise
-Unterabschnitten)### Schritt N:
(kann auch als## Validierung
erscheinen)## Validierungscheckliste## Haeufige Stolperfallen## Verwandte Skills
# Jeden erforderlichen Abschnitt pruefen for section in "## When to Use" "## Inputs" "## Procedure" "## Common Pitfalls" "## Related Skills"; do grep -q "$section" skills/<skill-name>/SKILL.md && echo "$section: OK" || echo "$section: FEHLT" done # Validierungsabschnitt kann beide Ueberschriften verwenden grep -qE "## Validation( Checklist)?" skills/<skill-name>/SKILL.md && echo "Validation: OK" || echo "Validation: FEHLT"
Erwartet: Alle sechs Abschnitte vorhanden. Vorgehensweisesabschnitt enthaelt mindestens eine
### Step-Unterueberschrift.
Bei Fehler: Jeden fehlenden Abschnitt als BLOCKIEREND melden. Ein Skill ohne alle sechs Abschnitte ist nicht konform mit dem agentskills.io-Standard. Die Abschnittsvorlage aus dem
create-skill-Meta-Skill bereitstellen.
Schritt 7: Format der Vorgehensweisenschritte pruefen
Verifizieren dass jeder Vorgehensweisenschritt dem erforderlichen Muster folgt: nummerierter Schritttitel, Kontext, Codeblock(s) und Erwartet:/Bei Fehler:-Blocks.
Fuer jeden
### Step N:-Unterabschnitt pruefen:
- Der Schritt hat einen beschreibenden Titel (nicht nur "Step N")
- Mindestens ein Codeblock oder eine konkrete Anweisung existiert
- Ein
-Block ist vorhanden**Erwartet:** - Ein
-Block ist vorhanden**Bei Fehler:**
Erwartet: Jeder Vorgehensweisenschritt hat sowohl Erwartet:- als auch Bei Fehler:-Blocks. Schritte enthalten konkreten Code oder Anweisungen, keine vagen Beschreibungen.
Bei Fehler: Jeden Schritt dem Erwartet/Bei Fehler fehlt als BLOCKIEREND melden. Wenn Schritte nur vage Anweisungen enthalten ("das System geeignet konfigurieren"), als VORSCHLAG mit Hinweis auf Hinzufuegen konkreter Befehle melden.
Schritt 7: Zeilenzahl verifizieren
Pruefen dass die SKILL.md innerhalb der 500-Zeilen-Grenze liegt.
lines=$(wc -l < skills/<skill-name>/SKILL.md) [ "$lines" -le 500 ] && echo "OK ($lines Zeilen)" || echo "UEBER LIMIT ($lines Zeilen > 500)"
Erwartet: Zeilenzahl ist 500 oder weniger.
Bei Fehler: Wenn ueber 500 Zeilen, als BLOCKIEREND melden. Empfehlen den Skill
refactor-skill-structure zu verwenden um Codeblocks >15 Zeilen nach references/EXAMPLES.md zu extrahieren. Typische Reduktion: 20-40% durch Extraktion erweiterter Beispiele.
Schritt 7: Registry-Synchronisierung pruefen
Verifizieren dass der Skill in
skills/_registry.yml unter der korrekten Domain mit uebereinstimmenden Metadaten aufgefuehrt ist.
Pruefen:
- Skill-
existiert unter dem korrekten Domain-Abschnittid
stimmt mitpath
ueberein<skill-name>/SKILL.md
stimmt mit Frontmatter uebereincomplexity
ist vorhanden (kann abgekuerzt sein)description
-Zahl oben in der Registry stimmt mit tatsaechlicher Skill-Zahl uebereintotal_skills
# Pruefen ob Skill in Registry ist grep -q "id: <skill-name>" skills/_registry.yml && echo "Registry: GEFUNDEN" || echo "Registry: NICHT GEFUNDEN" # Pfad pruefen grep -A1 "id: <skill-name>" skills/_registry.yml | grep -q "path: <skill-name>/SKILL.md" && echo "Pfad: OK" || echo "Pfad: STIMMT NICHT"
Erwartet: Skill ist in der Registry unter der korrekten Domain mit uebereinstimmendem Pfad und Metadaten aufgefuehrt. Gesamtzahl ist korrekt.
Bei Fehler: Wenn nicht in Registry gefunden, als BLOCKIEREND melden. Die Registry-Eintragsvorlage bereitstellen:
- id: skill-name path: skill-name/SKILL.md complexity: intermediate language: multi description: Einzeilige Beschreibung
Validierung
- SKILL.md-Datei existiert am erwarteten Pfad
- YAML-Frontmatter parst fehlerfrei
- Alle vier erforderlichen Frontmatter-Felder vorhanden (
,name
,description
,license
)allowed-tools - Alle sechs Metadatenfelder vorhanden (
,author
,version
,domain
,complexity
,language
)tags -
-Feld stimmt mit Verzeichnisname uebereinname -
ist unter 1024 Zeichendescription - Alle sechs erforderlichen Abschnitte vorhanden (Wann verwenden, Eingaben, Vorgehensweise, Validierung, Haeufige Stolperfallen, Verwandte Skills)
- Jeder Vorgehensweisenschritt hat Erwartet:- und Bei Fehler:-Blocks
- Zeilenzahl ist 500 oder weniger
- Skill ist in
mit korrekter Domain, Pfad und Metadaten aufgefuehrt_registry.yml -
-Zahl in Registry ist korrekttotal_skills
Haeufige Stolperfallen
- Frontmatter nur mit Regex pruefen: YAML-Parsing kann subtil sein. Ein
-Mehrzeilenblock sieht anders aus alsdescription: >
. Beide Muster pruefen wenn nach Feldern gesucht wird.description: "inline" - Die Validierungs-Abschnittsvariante uebersehen: Einige Skills verwenden
statt## Validierungscheckliste
. Beide sind akzeptabel; auf beide Ueberschriften pruefen.## Validierung - Registry-Gesamtzahl vergessen: Nach dem Hinzufuegen eines Skills zur Registry muss auch die
-Zahl oben inkrementiert werden. Dies wird haeufig in PRs uebersehen.total_skills - Name vs. Titel Verwechslung: Das
-Feld muss Kebab-Case sein und mit dem Verzeichnisnamen uebereinstimmen. Diename
-Ueberschrift ist menschenlesbar und kann sich unterscheiden (z.B. name:# Titel
, Titel:review-skill-format
).# Skill-Format pruefen - Nachsichtiger Modus ueberspringt Blockierer: Auch im nachsichtigen Modus sollten fehlende erforderliche Abschnitte und Frontmatter-Felder weiterhin gemeldet werden. Der nachsichtige Modus lockert nur Stil- und Metadatenempfehlungen.
Verwandte Skills
-- Die kanonische Formatspezifikation; als massgebliche Referenz verwenden wie eine gueltige SKILL.md aussiehtcreate-skill
-- Nach bestandener Formatvalidierung verwenden um die Inhaltsqualitaet zu verbessernupdate-skill-content
-- Wenn ein Skill die Zeilenzahlpruefung nicht besteht, zur Extraktion und Neuorganisation verwendenrefactor-skill-structure
-- Bei der Pruefung eines PR der Skills hinzufuegt oder aendert, PR-Pruefung mit Formatvalidierung kombinierenreview-pull-request- (Translations only) All five translation frontmatter fields present (
,locale
,source_locale
,source_commit
,translator
)translation_date - (Translations only) Body paragraphs are in the target locale, not English
- (Translations only) Code blocks are identical to the English source