Skip to content

README_DE.md

Latest commit

 

History

History
341 lines (241 loc) · 15.7 KB

README_DE.md

File metadata and controls

341 lines (241 loc) · 15.7 KB
Raw

🧰 AI Development Context Framework

Spezifikationen, Leitplanken und Projektgedächtnis für Coding-Agenten.

Lizenz: MIT Markdown Claude Code Edition Sterne

Dateien Leitplanken Triage Synchronisierung


🧭  Dein Coding-Agent verliert zwischen Sitzungen immer wieder Produktabsicht, Architekturentscheidungen und Aufgabenkontext?
📚  Ein kleines Projekt braucht eine schlanke Einrichtung, während ein größeres dauerhafte Spezifikationen und Übergaben benötigt?
🔒  Der Agent soll den Fortschritt selbstständig pflegen und zugleich Entscheidungen schützen, die eine Freigabe erfordern?

✨ Verwandle Produktgespräche in ein lebendes Kontextsystem für Coding-Agenten.

Besprechen → spezifizieren → initialisieren → entwickeln → Kontext pflegen


🧩 Editionen · ✨ Highlights · 🗺 Ablauf · 📦 Dateien · ⚡ Installation · 🚀 Verwendung · 🛡 Prinzipien · 🎬 Beispiel · 📂 Struktur · 📌 Hinweise

English · 简体中文 · Español · Deutsch · 日本語 · Русский · Português · 한국어

🧩 Edition wählen

Full Lite
Skills spec-gen, project-init, readme-craft spec-gen-lite, project-init-lite
Projektdateien 3 Kerndateien, bei Auslösung bis zu 9 3 Kerndateien
Aufgabenmodell Prioritätswarteschlange, Triage-Kopfzeilen, Probleme, Entscheidungen und Übergaben Phasenwarteschlange mit Größen [S/M/L/XL]
Am besten geeignet für Arbeit mit mehreren Modulen, längere Projekte, mehrere Sitzungen oder Teamübergaben Fokussierte Einzelprojekte, Prototypen und kurze Lieferzyklen
Installationsquelle skills/ lite/skills/

Beide Editionen befinden sich in diesem Repository. Installiere nur eine Edition in einer Coding-Umgebung, damit sich die Auslöser der beiden Skill-Paare eindeutig zuordnen lassen.

✨ Drei Skills, ein Framework

Skill Eingabe Ausgabe Platz im Arbeitsablauf
spec-gen Produktgespräch und Einschränkungen Eine strukturierte SPEC.md Zuerst: Produkt definieren
project-init Eine vorhandene SPEC.md Projektleitlinien und Verwaltungsdateien Danach: Coding-Umgebung vorbereiten
readme-craft Repository-Fakten und Zielgruppe Eine ausgearbeitete Projektdatei README.md Eigenständig: Projekt öffentlich erklären

Der zentrale Entwicklungsweg verwendet zunächst spec-gen und anschließend project-init. readme-craft ist ein unabhängiger Dokumentations-Skill im selben Repository.

🗺 Arbeitsablauf

flowchart LR
    A([Produkt besprechen]) --> B[spec-gen]
    B --> C[SPEC.md]
    C --> D[project-init]
    D --> E[CLAUDE.md]
    D --> F[TODO.md]
    D -. bei Bedarf .-> G[ARCHITECTURE · SCHEMA · DESIGN]
    E --> H([Coding-Agent])
    F --> H
    G --> H
    H -. erstes Problem .-> I[ISSUES.md]
    H -. erste Entscheidung .-> J[DECISIONS.md]
    H -. sitzungsübergreifende Übergabe .-> K[PROGRESS.md]
    H --> L([Mit Kontext entwickeln])

    M([Repository-Fakten]) --> N[readme-craft]
    N --> O[README.md]

    style A fill:#FEF3C7,stroke:#F59E0B,stroke-width:2px,color:#000
    style B fill:#DBEAFE,stroke:#3B82F6,stroke-width:2px,color:#000
    style C fill:#EDE9FE,stroke:#8B5CF6,stroke-width:2px,color:#000
    style D fill:#DBEAFE,stroke:#3B82F6,stroke-width:2px,color:#000
    style E fill:#F1F5F9,stroke:#64748B,stroke-width:1px,color:#000
    style F fill:#F1F5F9,stroke:#64748B,stroke-width:1px,color:#000
    style G fill:#F8FAFC,stroke:#94A3B8,stroke-width:1px,stroke-dasharray:4 4,color:#000
    style H fill:#DCFCE7,stroke:#22C55E,stroke-width:2px,color:#000
    style I fill:#FEF2F2,stroke:#EF4444,stroke-width:1px,stroke-dasharray:4 4,color:#000
    style J fill:#FFFBEB,stroke:#F59E0B,stroke-width:1px,stroke-dasharray:4 4,color:#000
    style K fill:#F0FDF4,stroke:#22C55E,stroke-width:1px,stroke-dasharray:4 4,color:#000
    style L fill:#DCFCE7,stroke:#22C55E,stroke-width:2px,color:#000
    style M fill:#FEF3C7,stroke:#F59E0B,stroke-width:2px,color:#000
    style N fill:#DBEAFE,stroke:#3B82F6,stroke-width:2px,color:#000
    style O fill:#EDE9FE,stroke:#8B5CF6,stroke-width:2px,color:#000
Loading

project-init liest die SPEC und entscheidet, wie viel Struktur das Projekt benötigt. Außerdem schreibt der Skill natürlichsprachliche Wartungsregeln in CLAUDE.md. Ein Agent, der diese Regeln befolgt, kann zustandsführende Dateien anlegen, sobald der erste echte Auslöser eintritt; kein Laufzeit-Hook erzwingt dieses Verhalten.

📦 Was erzeugt wird

Kerndateien

Datei Quelle Zweck
SPEC.md spec-gen Produktumfang, Module, Einschränkungen, Datenbedarf und MVP-Grenze
CLAUDE.md project-init Einstiegspunkt für den Agenten, Berechtigungen, Repository-Übersicht und Automatisierungsregeln
TODO.md project-init Eine priorisierte Warteschlange mit einem fokussierten Abschnitt zur aktuellen Aufgabe

Hinzugefügt, wenn die SPEC sie verlangt

Datei Auslöser Zweck
ARCHITECTURE.md Drei oder mehr Funktionsmodule Systemstruktur, Abhängigkeiten, Schnittstellen und Datenfluss
SCHEMA.md Eine Datenbank oder ein komplexes Datenmodell Entitäten, Felder, Einschränkungen, Indizes und Migrationen
DESIGN.md Eine Benutzeroberfläche Visuelles System, Komponenten, Abläufe, Zustände und responsives Verhalten

Während der Entwicklung erstellt

Datei Erster Auslöser Zweck
ISSUES.md Ein Fehler, technisches Problem, eine Einschränkung oder offene Frage Strukturierte Problemverfolgung mit Status und Modul-IDs
DECISIONS.md Eine technische oder architektonische Wahl Entscheidungsprotokolle, verworfene Optionen und Grad der Umkehrbarkeit
PROGRESS.md Die erste sitzungsübergreifende Übergabe Aktuelle Phase, Blockaden, Meilensteine und Wiedereinstiegspunkt

Das Framework beginnt mit drei Dateien und kann auf neun anwachsen. Jede zusätzliche Datei besitzt einen konkreten Auslöser.

⚡ Installation

Diese Anleitung installiert die Full-Edition. Für die Einrichtung mit drei Kerndateien verwendest du die Lite-Installationsanleitung.

Gib Claude Code diese Zeile:

Entferne die fünf verwalteten Skill-Verzeichnisse der Full- und Lite-Edition aus dem Zielbereich und installiere anschließend alle drei Full-Skills aus https://github.com/okht/ai-dev-context-framework/tree/main/skills.

🛠️ Manuell installieren

Klone das Repository:

git clone --depth=1 https://github.com/okht/ai-dev-context-framework.git

Installiere die Skills global für Claude Code und bereinige alle verwalteten Lite-Skills:

bash ai-dev-context-framework/scripts/sync-skills.sh full

Installiere sie im aktuellen Projekt und bereinige alle verwalteten Lite-Skills:

mkdir -p .claude/skills
rm -rf .claude/skills/spec-gen .claude/skills/project-init .claude/skills/readme-craft .claude/skills/spec-gen-lite .claude/skills/project-init-lite
cp -r ai-dev-context-framework/skills/* .claude/skills/

Starte nach der Installation einen neuen Claude-Code-Turn, damit der Skill-Index aktualisiert wird.

Für die Entwicklung an diesem Repository kopiert das enthaltene Synchronisierungsskript die aktuellen skills/-Verzeichnisse nach ~/.claude/skills/:

bash scripts/sync-skills.sh full

Das Synchronisierungsskript entfernt die fünf verwalteten Skill-Verzeichnisse der Full- und Lite-Edition und kopiert anschließend die ausgewählte Full-Edition. Andere globale Skills bleiben erhalten. Prüfe das Skript und das Zielverzeichnis vor der Ausführung.

Andere KI-Coding-Werkzeuge können die Markdown-Anweisungen und Vorlagen direkt verwenden. Skill-Erkennung und Aufrufsyntax hängen vom Host ab.

🚀 Verwendung

1. Aus dem Gespräch eine SPEC erstellen

/spec-gen

Oder frage in natürlicher Sprache:

Verwandle unser Produktgespräch in eine strukturierte SPEC.

spec-gen schreibt SPEC.md mit Produktübersicht, Funktionsmodulen, nichtfunktionalen Anforderungen, Datenbedarf, technischen Einschränkungen, MVP-Umfang und Glossar.

2. Projektkontext initialisieren

/project-init

project-init prüft, ob SPEC.md vorhanden ist, erstellt die Kerndateien, bewertet bedingte Dateien und bettet Wartungsregeln für die spätere Entwicklung ein.

3. Einen öffentlichen Projektleitfaden erstellen

/readme-craft

Verwende readme-craft unabhängig, wenn das Repository eine verständliche öffentliche README auf Grundlage geprüfter Projektfakten benötigt.

🛡 Gestaltungsprinzipien

Prinzip Umsetzung im Framework
LLM-lesbare Struktur Stabile Überschriften, ausdrückliche Beziehungen, Tabellen und Klartextregeln
Berechtigungen auf Prompt-Ebene Gesperrte und generierte Bereiche zeigen dem Agenten, welche Änderungen der Ablauf erwartet
Trennung von Prozess und Entscheidung Routinemäßiger Fortschritt kann schnell erfolgen, während Produkt- und Architekturänderungen eine Freigabe erfordern
An Komplexität angepasste Dateien Kleine Projekte bleiben schlank; zusätzliche Dateien entstehen durch ausdrückliche Signale
Begrenzte Dokumentgröße Eine SPEC mit mehr als 300 Zeilen fordert eine Modulaufteilung unter docs/spec/ an
Deterministische Zusammenfassungen Statuskopfzeilen werden aus Anzahlen, Modulen, IDs und Datumswerten neu aufgebaut

Gesperrte und generierte Bereiche

Erzeugte Dateien markieren ihre Grenzen mit HTML-Kommentaren:

<!-- 🔒 START 锁定区：规则 -->
Regeln, die der Agent beibehalten muss
<!-- 🔒 END 锁定区：规则 -->

<!-- 🔓 START 生成区：项目内容 -->
Projektspezifischer Inhalt, den der Agent pflegen kann
<!-- 🔓 END 生成区：项目内容 -->

Die erzeugten Anweisungen verlangen eine Bestätigung durch den Benutzer, bevor wesentliche Änderungen an SPEC.md, ARCHITECTURE.md, SCHEMA.md, DESIGN.md und DECISIONS.md erfolgen. Prozessdateien wie TODO.md, ISSUES.md und PROGRESS.md sind für die routinemäßige Pflege durch den Agenten vorgesehen. Diese Kontrollen sind Markdown-Konventionen und hängen von der Regelbefolgung des Agenten ab.

Schnelle Triage-Kopfzeilen

TODO.md, ISSUES.md, PROGRESS.md und DECISIONS.md beginnen mit einem kompakten, mechanisch abgeleiteten Statusblock.

Datei Fokus der Kopfzeile
TODO.md Anzahl laufender Aufgaben, Verteilung des Backlogs, nächste Aktion, Aktualisierungsdatum
ISSUES.md Aktive Module, erster relevanter Eintrag, Statusanzahlen, MVP-Blockaden
PROGRESS.md Phase, Meilensteinfortschritt, Blockaden, Wiedereinstiegspunkt
DECISIONS.md Irreversible Entscheidungen, Anzahl und Aktualisierungsdatum

Jede Vorlage enthält den Algorithmus zum Neuaufbau in einem gesperrten Abschnitt. Nach einer Änderung am Hauptteil berechnet der Agent die vollständige Kopfzeile erneut aus den Quelleinträgen.

🎬 Beispiel: ChatLens

Das Verzeichnis examples/ enthält einen vollständig ausgefüllten Satz für ChatLens, ein fiktives B2B-Produkt zur Gesprächsanalyse.

Was das Beispiel zeigt Wichtiger Kontext
Alle neun Projektdateien Sie wurden bewusst gemeinsam erzeugt, um jede Vorlage zu demonstrieren
Gesperrte und generierte Bereiche Das Berechtigungsmodell in realistischen Dokumenten
Triage-Kopfzeilen und Algorithmen Wie Statuszusammenfassungen mechanisch abgeleitet bleiben
Dateiübergreifende Verweise Wie Aufgaben, Probleme, Entscheidungen und Fortschritt zusammenhängen

Reale Projekte befolgen die Auslöserregeln. Ein kleines Projekt kann ausschließlich SPEC.md, CLAUDE.md und TODO.md verwenden.

📂 Projektstruktur

ai-dev-context-framework/
├── README.md
├── LICENSE
├── scripts/
│   └── sync-skills.sh
├── skills/
│   ├── spec-gen/
│   │   ├── SKILL.md
│   │   └── templates/SPEC.md.example
│   ├── project-init/
│   │   ├── SKILL.md
│   │   └── templates/*.md.example
│   └── readme-craft/
│       ├── SKILL.md
│       ├── agents/openai.yaml
│       ├── references/
│       │   ├── visual-system.md
│       │   └── verification.md
│       ├── scripts/validate_readme.py
│       └── templates/README.md.example
├── lite/
│   ├── README.md
│   ├── WORKFLOW.md
│   └── skills/
│       ├── spec-gen-lite/SKILL.md
│       └── project-init-lite/SKILL.md
└── examples/
    ├── SPEC.md
    ├── CLAUDE.md
    ├── TODO.md
    ├── ARCHITECTURE.md
    ├── SCHEMA.md
    ├── DESIGN.md
    ├── ISSUES.md
    ├── DECISIONS.md
    └── PROGRESS.md

Das Repository enthält Skills, wiederverwendbare Vorlagen, ein vollständiges Beispiel und ein Synchronisierungswerkzeug für Entwickler. Es enthält keine Anwendungslaufzeit.

📌 Hinweise

  • spec-gen und project-init bilden den zentralen Projektablauf.
  • readme-craft ist ein eigenständiger Skill zum Schreiben von READMEs.
  • lite/ ist die Edition mit drei Kerndateien, die im selben Repository gepflegt wird.
  • Installiere in einer Coding-Umgebung entweder die Full- oder die Lite-Edition, damit sich überlappende Skill-Auslöser vermieden werden.
  • project-init erwartet eine vorhandene, vollständige SPEC.md.
  • Der ChatLens-Satz mit neun Dateien ist eine Demonstration; die reguläre Ausgabe skaliert mit der Projektkomplexität.
  • scripts/sync-skills.sh full|lite bereinigt die jeweils andere verwaltete Edition, bevor die ausgewählten globalen Skills kopiert werden.
  • Das Repository verteilt derzeit Skill-Quellordner und veröffentlicht keine gepackten .skill-Releases.

Issues und Pull Requests sind willkommen.

Halte Produktabsicht, Implementierungskontext und Projektstatus im selben System.


MIT-Lizenz © okht