Spec-First-Workflow
Anforderungen definieren, bevor Code geschrieben wird.
OpenSpecSpeifikationsgetriebene Entwicklung für KI-Assistenten
Eine leichte Spezifikation zum Erstellen und Verwalten von KI-Assistenten-Projekten.
Eine leichte Spezifikation zum Erstellen und Verwalten von KI-Assistenten-Projekten.
Willkommen. Dies ist die zentrale Anlaufstelle für alles rund um OpenSpec.
OpenSpec hilft Ihnen und Ihrem KI-Coding-Assistenten, sich darauf zu einigen, was gebaut werden soll, bevor auch nur eine Zeile Code geschrieben wird. Sie beschreiben die Änderung, der KI entwirft einen kurzen Spezifikationsentwurf und eine Aufgabenliste, beide betrachten denselben Plan, und dann erfolgt die Umsetzung. Keine Überraschungen mehr zur Hälfte des Prozesses, dass die KI das Falsche gebaut hat.
Wenn Sie nur zwei Seiten lesen sollten, dann diese:
/opsx:propose ein (Tipp: im KI-Chat, nicht im Terminal). Das verwirrt fast jeden einmal.Der zweite Punkt ist wichtiger, als er aussieht. OpenSpec besteht aus zwei Teilen: einem CLI-Tool, das Sie im Terminal ausführen, und Slash-Befehlen, die Sie an Ihren KI-Assistenten senden. Zu wissen, welcher Befehl wohin gehört, spart Ihnen die häufigste Verwirrung.
Die wichtigste Angewohnheit, die Sie sich zuerst aneignen sollten: Wenn Sie unsicher sind, was Sie bauen sollen, beginnen Sie mit
/opsx:explore. Es ist ein risikofreier Denkp_partner_, der Ihren Code liest, Optionen abwägt und eine vage Idee in einen konkreten Plan verwandelt, bevor es Artefakte oder Code gibt. Die Anleitung Explore First begründet dies.
Ich bin völlig neu hier. Beginnen Sie mit Erste Schritte, blättern Sie dann durch Kernkonzepte auf einen Blick. Wenn etwas rätselhaft erscheint, sind das FAQ und das Glossar in Reichweite.
Ich habe ein Problem, aber keinen Plan. Dies ist der häufige Fall, und dafür gibt es eine dedizierte Antwort: Explore First. Nutzen Sie /opsx:explore, um die Sache gemeinsam mit der KI durchzudenken, bevor Sie sich festlegen.
Ich habe einen großen bestehenden Codebase. Sie dokumentieren nicht alles. OpenSpec in einem bestehenden Projekt verwenden zeigt, wie Sie bei echtem Brownfield-Code starten, ohne das Meer auszutrinken („boiling the ocean").
Ich will einfach nur, dass es funktioniert. Installieren, führen Sie openspec init aus, und lesen Sie dann So funktionieren Befehle, damit Ihr erster Slash-Befehl am richtigen Ort landet. Oder übergeben Sie die Einrichtung Ihrem Assistenten mit dem KI-unterstützten Installationsprompt.
Ich lerne anhand von Beispielen. Die Seite Beispiele & Rezepte führt reale Änderungen von Anfang bis Ende vor: eine kleine Funktion, eine Fehlerbehebung, ein Refactoring, eine Exploration.
Die KI hat gerade einen Entwurf erstellt — was nun? Lesen Sie ihn. Eine Änderung überprüfen zeigt den Zwei-Minuten-Durchgang, der eine falsche Richtung erkennt, solange sie noch günstig ist, und Gute Spezifikationen schreiben behandelt, woraus ein genehmigungswürdiger Plan besteht.
Ich arbeite in einem Team. OpenSpec im Team zeigt, wie eine Änderung auf einen Branch und einen Pull Request abbildet und wie Teamkollegen einen Plan vor dem Code überprüfen.
Ich komme vom alten Workflow. Der Migrationsleitfaden erklärt, was sich geändert hat und warum, und versichert, dass Ihre bisherigen Arbeiten sicher sind.
Ich möchte es an den Prozess meines Teams anpassen. Anpassung behandelt Projektkonfiguration, benutzerdefinierte Schemas und gemeinsamen Kontext.
Etwas ist kaputt. Fehlerbehebung sammelt die Fehler, auf die Leute tatsächlich stoßen, zusammen mit Lösungen.
| Doc | Was es bietet |
|---|---|
| Erste Schritte | Installation, Initialisierung und Durchführung Ihrer ersten Änderung von Anfang bis Ende |
| Explore First | Nutzen Sie /opsx:explore, um eine Idee durchzudenken, bevor Sie sich festlegen |
| So funktionieren Befehle | Wo Slash-Befehle ausgeführt werden, was „interaktiver Modus“ bedeutet, Terminal vs. Chat |
| Kernkonzepte auf einen Blick | Das gesamte mentale Modell auf einer Seite: Spezifikationen, Änderungen, Deltas, Archiv |
| Installation | npm, pnpm, yarn, bun, Nix, ein Prompt, der die Einrichtung an Ihren KI-Assistenten übergibt, und wie Sie prüfen, ob es funktioniert hat |
| Doc | Was es bietet |
|---|---|
| Workflows | Häufige Muster und wann man welchen Befehl verwendet |
| Beispiele & Rezepte | Vollständige Durchgänge realer Änderungen, kopier- und einfügbar |
| Gute Spezifikationen schreiben | Wie eine starke Anforderung und ein Szenario aussehen und wie man eine Änderung richtig dimensioniert |
| Eine Änderung überprüfen | Der Zwei-Minuten-Durchgang eines entwurften Plans, bevor Code geschrieben wird |
| OpenSpec im Team | Wie Änderungen in Branches, Pull Requests und Reviews passen |
| OpenSpec in einem bestehenden Projekt verwenden | Einführung von OpenSpec in einer großen Brownfield-Codebase |
| Änderungen bearbeiten und iterieren | Artefakte aktualisieren, zurückgehen, manuelle Bearbeitungen reconcilieren |
| Befehle | Referenz für jeden /opsx:*-Slash-Befehl |
| CLI | Referenz für jeden openspec-Terminalbefehl |
| Doc | Was es bietet |
|---|---|
| Konzepte | Die ausführliche Erklärung von Spezifikationen, Änderungen, Artefakten, Schemas und Archiv |
| OPSX-Workflow | Warum der Workflow fließend statt phasenfixiert ist, plus ein Architektur-Tiefgang |
| Glossar | Jeder Begriff an einer Stelle definiert |
| Doc | Was es bietet |
|---|---|
| Anpassung | Projektkonfiguration, benutzerdefinierte Schemas, gemeinsamer Kontext |
| Mehrsprachig | Artefakte in Sprachen außer Englisch generieren |
| Unterstützte Tools | Die 30+ KI-Tools, mit denen OpenSpec integriert ist, und wo Dateien landen |
| Community Showcase | Projekte und Ressourcen, die mit und für OpenSpec erstellt wurden |
| Doc | Was es bietet |
|---|---|
| FAQ | Schnelle Antworten auf die am häufigsten gestellten Fragen |
| Fehlerbehebung | Konkrete Lösungen für konkrete Fehler |
| Migrationsleitfaden | Wechsel vom Legacy-Workflow zu OPSX |
| Doc | Was es bietet |
|---|---|
| Stores: Benutzerhandbuch | Planen Sie in einem eigenen Repo, wenn Ihre Arbeit Repos oder Teams überschreitet |
| Agent Contract | Die maschinenlesbaren CLI-Oberflächen, die Agents antreiben |
1. Installieren npm install -g @fission-ai/openspec@latest
2. Initialisieren cd your-project && openspec init
3. Erkunden (in Ihrem KI-Chat) /opsx:explore ← optional, aber eine großartige Angewohnheit
4. Vorschlagen (in Ihrem KI-Chat) /opsx:propose add-dark-mode
5. Bauen (in Ihrem KI-Chat) /opsx:apply
6. Archivieren (in Ihrem KI-Chat) /opsx:archiveSchritt 1 und 2 erfolgen in Ihrem Terminal. Der Rest erfolgt im Chat Ihres KI-Assistenten. Diese Trennung ist das Einzige, was es sich lohnt, sich zu merken, und So funktionieren Befehle erklärt genau, warum. Schritt 3 ist optional, aber der Beginn mit /opsx:explore, wenn Sie unsicher sind, ist die Angewohnheit, die sich am meisten lohnt.
openspec feedback "your message" sendet Feedback direkt aus Ihrem Terminal heraus (es öffnet ein GitHub-Issue).Haben Sie etwas in diesen Docs gefunden, das falsch, veraltet oder verwirrend ist? Das ist ein Bug. Öffnen Sie ein Issue oder einen PR. Dokumentationsverbesserungen sind einige der wertvollsten Beiträge, die Sie leisten können.