component-doc-writer
Skill1 starsChanged 46 days agoMITView on GitHub
Schreibt Nutzungs-, Props- und Accessibility-Dokumentation für eine Komponente. Nutzen, wenn eine Komponente dokumentiert werden soll.
In this repository81 other files it gives its agents.
- accessibility-action-planSkill
- accessibility-auditSkill
- accessibility-finding-explainerSkill
- accessibility-report-summarySkill
- agent-config-authoringSkill
- agents-sdkSkill
- ai-ux-patternsSkill
- alt-text-generatorSkill
- anti-ai-copySkill
- aria-usage-reviewSkill
- astro-architectureSkill
- astro-client-scriptsSkill
- astro-component-a11y-reviewSkill
- before-after-accessibility-commsSkill
- bfsg-risk-language-softenerSkill
- biomeSkill
- blog-from-transcriptSkill
- brand-voice-dnaSkill
- case-study-from-auditSkill
- client-email-after-auditSkill
- cloudflare-email-serviceSkill
- cloudflare-one-migrationsSkill
- cloudflare-oneSkill
- cloudflareSkill
- complexity-judgmentSkill
- content-clarity-a11y-checkSkill
- content-qaSkill
- conversation-retrospectiveSkill
- darkmodeSkill
- deep-researchSkill
- design-directionsSkill
- design-systemsSkill
- durable-objectsSkill
- faq-from-issuesSkill
- form-accessibility-reviewSkill
- frontend-designSkill
- handoffSkill
- i18nSkill
- image-to-webpSkill
- keyboard-navigation-reviewSkill
- knowledge-baseSkill
- landing-and-site-builderSkill
- landingpage-from-briefingSkill
- lighthouse-axe-result-explainerSkill
- linkedin-post-from-contentSkill
- llm-councilSkill
- local-business-seoSkill
- mcp-builderSkill
- mdx-contentSkill
- motion-designSkill
- native-html-uiSkill
- newsletter-from-auditSkill
- overlay-tool-risk-explainerSkill
- playwrightSkill
- post-auditSkill
- remotionSkill
- sandbox-migrate-to-nextSkill
- sandbox-nextSkill
- sandbox-sdkSkill
- sandbox-stableSkill
- The first 60 shown.
The file
Files
Component-Doc-Writer
Schreibt kompakte Komponenten-Doku: Zweck, Props, Verwendung, Accessibility-Hinweise, Varianten.
Wann verwenden
- Eine Komponente (
.astro,.tsx,.svelte) soll dokumentiert werden. - Vorhandene Doku soll um Props/a11y ergänzt werden.
Input
- Komponenten-Code (oder Pfad), inkl. Props/Signatur.
Prüf-Vorgehen
- Zweck aus Code/Verwendung ableiten (1–2 Sätze, kein Marketing).
- Props aus Signatur/
interface/Astro.propsextrahieren. - Mindestens ein copy-paste-fähiges Verwendungsbeispiel bauen.
- a11y-Anforderungen ableiten: braucht die Komponente ein Label? Verwaltet sie Fokus? Erwartet sie
alt? - Varianten/Zustände auflisten (Größen, Farb-/Disabled-/Loading-States).
Output
Markdown mit Struktur:
- Zweck
- Props — Tabelle: Name / Typ / Default / Pflicht / Beschreibung.
- Verwendung — lauffähiges Beispiel.
- Accessibility — was der Aufrufer sicherstellen muss (z.B. „braucht sichtbares Label oder
aria-label"). - Varianten — Liste mit Kurzbeschreibung.
Gotchas
- a11y-Verantwortung explizit dokumentieren: was muss der Aufrufer liefern (Label,
alt, eindeutigeid)? - Beispiele müssen ohne Anpassung lauffähig sein — echte Prop-Namen, keine Platzhalter wie
.... - Defaults aus dem Code lesen, nicht raten.
- Pflicht-Props deutlich kennzeichnen; fehlende führen sonst zu stillen Fehlern.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.