Proces oparty na specyfikacji
Zdefiniuj wymagania przed napisaniem kodu.
OpenSpecRozwój oparty na specyfikacji dla asystentów AI
Lekka specyfikacja do budowania i zarządzania projektami asystentów AI.
Lekka specyfikacja do budowania i zarządzania projektami asystentów AI.
Witamy. To centrum wszystkiego, co dotyczy OpenSpec.
OpenSpec pomaga Tobie i Twojemu asystentowi AI do kodowania umówić się, co ma zostać zbudowane, zanim napisze się jakikolwiek kod. Opisujesz zmianę, AI tworzy krótką specyfikację i listę zadań, oboje przeglądacie ten sam plan, a następnie przechodzicie do pracy. Koniec z sytuacjami, w których w połowie odkrywasz, że AI zbudowało coś innego niż oczekiwano.
Jeśli przeczytasz tylko dwie strony, to te:
/opsx:propose (podpowiedź: w czacie AI, nie w terminalu). To myli prawie każdego raz.Ta druga strona jest ważniejsza, niż się wydaje. OpenSpec ma dwie części: narzędzie wiersza poleceń uruchamiane w terminalu oraz polecenia z ukośnikiem przekazywane asystentowi AI. Wiedza o tym, które jest które, oszczędza najczęstszy moment zamieszania.
Najlepszy nawyk do wyrobienia na start: gdy nie jesteś pewien, co zbudować, zacznij od
/opsx:explore. To partner do myślenia bez ryzyka, który czyta Twój kod, waży opcje i doprecyzowuje mglisty pomysł w konkretny plan, zanim powstanie jakikolwiek artefakt lub kod. Przewodnik Najpierw eksploruj przedstawia argumenty.
Jestem zupełnie nowy. Zacznij od Szybki start, a następnie przejrzyj Podstawowe pojęcia w skrócie. Gdy coś wydaje się tajemnicze, FAQ i Glosariusz są w pobliżu.
Mam problem, ale nie mam planu. To najczęstszy przypadek i ma dedykowaną odpowiedź: Najpierw eksploruj. Użyj /opsx:explore, aby przemyśleć sprawę z AI, zanim cokolwiek postanowisz.
Mam dużą istniejącą bazę kodu. Nie musisz dokumentować wszystkiego. Używanie OpenSpec w istniejącym projekcie pokazuje, jak zacząć pracę nad prawdziwym, istniejącym kodem, nie próbując ogarnąć wszystkiego naraz.
Chcę tylko, żeby to działało. Zainstaluj, uruchom openspec init, a następnie przeczytaj Jak działają polecenia, aby Twoje pierwsze polecenie z ukośnikiem trafiło w odpowiednie miejsce. Albo powier setup asystentowi AI za pomocą promptu do instalacji z pomocą AI.
Uczę się na przykładach. Strona Przykłady i przepisy przeprowadza przez prawdziwe zmiany od początku do końca: małą funkcję, poprawkę błędu, refaktoryzację, eksplorację.
AI właśnie przygotowało plan — co teraz? Przeczytaj go. Recenzja zmiany pokazuje dwuminutowy przegląd, który wychwytuje błędny kierunek, gdy jest jeszcze tani, a Pisanie dobrych specyfikacji opisuje, z czego składa się plan wart zatwierdzenia.
Pracuję w zespole. OpenSpec w zespole pokazuje, jak zmiana mapuje się na gałąź i pull request, oraz jak koledzy z zespołu recenzują plan przed kodem.
Przychodzę ze starego procesu. Przewodnik migracji wyjaśnia, co się zmieniło i dlaczego, oraz zapewnia, że Twoja dotychczasowa praca jest bezpieczna.
Chcę dostosować to do procesu mojego zespołu. Konfigurowanie obejmuje konfigurację projektu, niestandardowe schematy i współdzielony kontekst.
Coś nie działa. Rozwiązywanie problemów zbiera błędy, na które ludzie faktycznie napotykają, wraz z poprawkami.
| Dokument | Co otrzymujesz |
|---|---|
| Szybki start | Instalacja, inicjalizacja i uruchomienie pierwszej zmiany od początku do końca |
| Najpierw eksploruj | Użyj /opsx:explore, aby przemyśleć pomysł, zanim się na niego zdecydujesz |
| Jak działają polecenia | Gdzie uruchamiają się polecenia z ukośnikiem, co oznacza „tryb interaktywny", terminal vs czat |
| Podstawowe pojęcia w skrócie | Cały model mentalny na jednej stronie: specyfikacje, zmiany, delty, archiwum |
| Instalacja | npm, pnpm, yarn, bun, Nix, prompt przekazujący setup asystentowi AI oraz jak zweryfikować, że wszystko zadziałało |
| Dokument | Co otrzymujesz |
|---|---|
| Przepływy pracy | Częste wzorce i kiedy sięgnąć po każde polecenie |
| Przykłady i przepisy | Pełne przejścia przez prawdziwe zmiany, gotowe do skopiowania |
| Pisanie dobrych specyfikacji | Jak wygląda silne wymaganie i scenariusz oraz jak odpowiednio skalować zmianę |
| Recenzja zmiany | Dwuminutowy przegląd przygotowanego planu, zanim napisze się jakikolwiek kod |
| OpenSpec w zespole | Jak zmiany pasują do gałęzi, pull requestów i recenzji |
| Używanie OpenSpec w istniejącym projekcie | Wdrażanie OpenSpec na dużej, istniejącej bazie kodu |
| Edycja i iterowanie zmiany | Aktualizacja artefaktów, cofanie, synchronizacja ręcznych edycji |
| Polecenia | Referencja każdego polecenia /opsx:* z ukośnikiem |
| CLI | Referencja każdego polecenia openspec w terminalu |
| Dokument | Co otrzymujesz |
|---|---|
| Pojęcia | Rozszerzone wyjaśnienie specyfikacji, zmian, artefaktów, schematów i archiwum |
| Przepływ OPSX | Dlaczego przepływ jest płynny zamiast zablokowany na etapy, plus szczegółowe omówienie architektury |
| Glosariusz | Każde pojęcie zdefiniowane w jednym miejscu |
| Dokument | Co otrzymujesz |
|---|---|
| Konfigurowanie | Konfiguracja projektu, niestandardowe schematy, współdzielony kontekst |
| Wielojęzyczność | Generowanie artefaktów w językach innych niż angielski |
| Obsługiwane narzędzia | Ponad 30 narzędzi AI, z którymi integruje się OpenSpec, oraz gdzie trafiają pliki |
| Pokaz społeczności | Projekty i zasoby stworzone z OpenSpec i dla OpenSpec |
| Dokument | Co otrzymujesz |
|---|---|
| FAQ | Szybkie odpowiedzi na najczęściej zadawane pytania |
| Rozwiązywanie problemów | Konkretny naprawy dla konkretnych awarii |
| Przewodnik migracji | Przejście ze starego przepływu na OPSX |
| Dokument | Co otrzymujesz |
|---|---|
| Stores: Przewodnik użytkownika | Planowanie w osobnym repozytorium, gdy Twoja praca obejmuje wiele repozytoriów lub zespołów |
| Umowa agenta | Maszynowo czytelne interfejsy CLI, które napędzają agenci |
1. Install npm install -g @fission-ai/openspec@latest
2. Initialize cd your-project && openspec init
3. Explore (in your AI chat) /opsx:explore ← opcjonalne, ale świetny nawyk
4. Propose (in your AI chat) /opsx:propose add-dark-mode
5. Build (in your AI chat) /opsx:apply
6. Archive (in your AI chat) /opsx:archiveKroki 1 i 2 odbywają się w terminalu. Reszta w czacie asystenta AI. To podział jest jedyną rzeczą wartą zapamiętania, a Jak działają polecenia dokładnie wyjaśnia dlaczego. Krok 3 jest opcjonalny, ale zaczynanie od /opsx:explore, gdy jesteś niepewny, to nawyk najbardziej warty wyrobienia.
openspec feedback "twoja wiadomość" — wysyła opinię bezpośrednio z terminalu (otwiera issue na GitHubie).Znalazłeś w tych dokumentach coś błędnego, nieaktualnego lub mylącego? To jest bug. Otwórz issue lub PR. Poprawy dokumentacji to jedne z najcenniejszych wkładów, jakie możesz wnieść.