Erstellung llms.txt-Datei & Markdown-Docs für KI-Konsumierbarkeit
# User Story ## Definition of Ready - [x] Abhängigkeiten sind definiert und geklärt - [x] Alle benötigten Informationen liegen vor - [x] Es wurde geprüft, ob das Thema für die Community aufbereitet werden muss - [x] Das Ticket wurde von allen Verstanden - [x] Das Ticket ist geschätzt ## Story Satz **Als Entwickler:in, die KI zur Unterstützung nutzt, möchte ich eine URL haben, die ich meiner bevorzugten KI geben kann und die von KI-Coding-Tools (Cursor, Copilot) automatisch erkannt wird, um relevante Informationen zu Komponenten von KERN zu erhalten — idealerweise auch als einzelne Markdown-Seiten pro Komponente.** ## Akzeptanzkriterien * [x] Das Plugin zur Erstellung llms.txt Dateien ist in der technischen Dokumentation installiert * [x] Das Plugin ist konfiguriert * [x] Präambel qualitätsgesichert (manuell geschrieben **oder** aus Plugin-Konfiguration generiert — je nach Plugin-Fähigkeiten) * [ ] ggf (siehe oben) Die generierte llms.txt Datei ist manuell überarbeitet * [ ] die Zielstruktur (siehe Beschreibung und wichtige Hinweise) ist in die llms.txt Datei ist integriert * [ ] Es gibt zwei URLs * [ ] https://www.kern-ux.de/llms.txt — für KI-Tools mit kurzem Kontextfenster * [ ] https://www.kern-ux.de/llms-full.txt — vollständige Version (alle Seiteninhalte) * [ ] Die `robots.txt` wurde geprüft: KI-Crawler (GPTBot, ClaudeBot, Bytespider, CCBot) sind nicht blockiert — oder die Blockierung ist eine bewusste Entscheidung, die dokumentiert ist * [ ] Jede Dokumentationsseite ist zusätzlich als Markdown unter `/{path}.md` abrufbar * [ ] ggf Ein `<link rel="alternate">` Tag wird in jede Seite injiziert * [ ] Es wurde getestet, welche Ergebnisse bei den Standard KI Programmen (Claude, Gemini, Copilot, ChatGPT) mit Nutzung der URLs herauskommen * [ ] Es wurden Fragen zur Komponentenliste an die Programme gestellt * [ ] Testergebnisse sind dokumentiert und die Community-Kommunikation ist darauf abgestimmt — inkl. ehrlicher Einordnung, was funktioniert und was (noch) nicht. Die Ergebnisse werden unabhängig vom Outcome mit der Community geteilt. ## Beschreibung und wichtige Hinweise #### Infos zur Konfiguration: js\ plugins: \[\ \[\ 'docusaurus-plugin-llms-txt',\ {\ siteDescription:\ 'KERN ist der offene UX-Standard für die digitale Verwaltung Deutschlands. ' +\ 'Betrieben von FITKO, entwickelt mit der bundesweiten Fachcommunity.',\ depth: 3,\ minify: false,\ // Optionale Ausschlüsse: alte Versionsseiten nicht in llms.txt aufnehmen\\ exclude: \['/2.0.6/', '/2.1.2/', '/2.2.0/', '/2.3.2/'\],\ },\ \],\ \], #### Infos zur Zielstruktur der llms.txt Datei Das Plugin generiert automatisch — aber die Qualität steigt erheblich, wenn die Präambel (die ersten ca. 20 Zeilen) manuell geschrieben wird. Das ist der Abschnitt, den KI-Systeme am stärksten gewichten.\ Zielstruktur der Präambel:
\ markdown\\ # KERN UX-Standard\\ \ \> Der offene UX-Standard für die digitale Verwaltung Deutschlands.\ \> Entwickelt von FITKO mit der bundesweiten Fachcommunity. Open Source (EUPL).\ \> Aktuelle Version: 2.4.0\ \ KERN stellt barrierefrei entwickelte UI-Komponenten, Design-Tokens und UX-Richtlinien\ für Verwaltungsdigitalisierung bereit — von Kommunal- bis Bundesebene.\ WCAG 2.1 AA ist der Mindeststandard für alle Komponenten.\ \ Verfügbare Implementierungen:\\ - Plain CSS/HTML: kern-ux/kern-ux-plain (offizielles Kit)\\ - React: kern-ux/community/kern-react-kit\\ - Angular: kern-ux/community/angular-kit\\ - Web Components: kern-ux/community/kern-webcomponents-light-kit\\ - Drupal: drupal.org/project/kern_ux\ \\ ## Foundations\\ - \[Design-Tokens\](https://www.kern-ux.de/design-system/foundations/tokens)\\\\ - \[Farbe\](https://www.kern-ux.de/design-system/foundations/farbe)\\\\ - \[Typografie\](https://www.kern-ux.de/design-system/foundations/typografie)\\\\ - \[Layout & Abstände\](https://www.kern-ux.de/design-system/foundations/layout)\\\\ - \[Barrierefreiheit\](https://www.kern-ux.de/design-system/barrierefreiheit)\\\\ - \[Icons\](https://www.kern-ux.de/design-system/foundations/icons)\\\\ \\ ## Komponenten\\ - \[Komponentenübersicht\](https://www.kern-ux.de/komponenten)\\\\ \[... ab hier generiert das Plugin automatisch aus der Docusaurus-Seitenstruktur\] ## Definition of Done - [ ] `llms.txt` und `llms-full.txt` sind unter den definierten URLs öffentlich erreichbar - [ ] Codeseitige Anpassungen sind erfolgt - (Plugin installiert, konfiguriert, Präambel geschrieben bzw durch neue Version generiert) - [ ] Testergebnisse mit mindestens 3 KI-Tools sind dokumentiert - [ ] Dokumentation auf kern-ux.de ist angepasst - [ ] Das Community Management hat die Community informiert - [ ] `robots.txt`-Status bezüglich KI-Crawler ist dokumentiert - [ ] Pflegeprozess bei neuen Releases ist definiert (Versionsnummer, ggf. neue Seiten in Präambel) \______________________________________________________________\_ ### **Hinweis bzgl strategische Einordnung bzgl Roadmap:** **Einordnung im KI-Lesbarkeit Aufgabenpaket.**\ Dies ist Baustein 1 von 3 der KI-Lesbarkeit bzw- Konsumierbarkeits-Strategie für KERN. Die **Component Registry** (Ticket #…) und **DESIGN.md** (Ticket #…) werden parallel bzw anschließend erarbeitet. Die drei Layer sind unabhängig umsetzbar, ergänzen sich aber: <table> <tr> <th>Layer</th> <th>Frage</th> <th>Status</th> </tr> <tr> <td> **llms.txt** ← dieses Ticket #606 </td> <td>Was ist KERN, wie navigiere ich die Doku?</td> <td>In Arbeit</td> </tr> <tr> <td> Component Registry https://gitlab.opencode.de/kern-ux/kern-ux-plain/-/work_items/246 </td> <td>Welche Komponenten gibt es, was ist ihre API?</td> <td>Parallel</td> </tr> <tr> <td>DESIGN.md</td> <td>Wie soll KERN-konforme UI aussehen?</td> <td>Geplant</td> </tr> </table> <!--Bitte die nachfolgende Zeile nicht ändern-->
issue