Dokumentacja OpenSpec ​

Witaj. To strona główna wszystkiego, co dotyczy OpenSpec.

OpenSpec pomaga Ci i Twojemu asystentowi kodującemu AI ustalić, co ma zostać zbudowane, zanim napisany zostanie jakikolwiek kod. Opisujesz zmianę, AI szkicuje krótką specyfikację i listę zadań, oboje patrzycie na ten sam plan, a następnie praca się odbywa. Koniec z odkrywaniem w połowie drogi, że AI zbudowało coś nieprawidłowego.

Jeśli przeczytasz tylko jedną rzecz, niech to będą te dwie strony:

1. Getting Started: instalacja, inicjalizacja i wysłanie Twojej pierwszej zmiany.
2. How Commands Work: gdzie faktycznie wpisujesz /opsx:propose (wskazówka: w swoim czacie AI, a nie w terminalu). To pułapka dla prawie każdego raz.

Ta druga jest ważniejsza, niż się wydaje. OpenSpec ma dwie części: narzędzie linii komendowej, które uruchamiasz w terminalu, oraz polecenia z ukośnikiem, które podajesz swojemu asystentowi AI. Wiedza, który jest który, ratuje Cię przed najczęstszym momentem nieporozumienia.

Najlepszy nawyk do zbudowania na początku: gdy nie jesteś pewien, co budować, zacznij od /opsx:explore. Jest to partner myślowy bez ryzyka, który czyta Twój kod, waży opcje i wyostrza mgliste pomysły w konkretny plan, zanim powstanie jakikolwiek artefakt lub kod. Przewodnik Explore First przedstawia tę tezę.

Wybierz swoją ścieżkę ​

Jestem kompletnie nowy. Zacznij od Getting Started, a następnie przejrzyj Core Concepts at a Glance. Gdy coś wydaje się tajemnicze, FAQ i Glossary są blisko.

Mam problem, ale nie mam planu. To jest typowy przypadek, a ma on dedykowaną odpowiedź: Explore First. Użyj /opsx:explore, aby przemyśleć to z AI przed zobowiązaniem się do czegokolwiek.

Mam dużą istniejącą bazę kodu. Nie dokumentujesz jej w całości. Using OpenSpec in an Existing Project pokazuje, jak zacząć od prawdziwego, "brązowego" kodu bez próby zjedzenia całego oceanu.

Chcę po prostu sprawić, by to działało. Install, uruchom openspec init, a następnie przeczytaj How Commands Work, aby Twoje pierwsze polecenie z ukośnikiem trafiło w odpowiednie miejsce.

Uczę się na przykładach. Strona Examples & Recipes przeprowadza przez rzeczywiste zmiany od początku do końca: mała funkcja, poprawka błędu, refaktoryzacja, eksploracja.

Przechodzę ze starego przepływu pracy. Migration Guide wyjaśnia, co się zmieniło i dlaczego, obiecując, że Twoja istniejąca praca jest bezpieczna.

Chcę dostosować to do procesu mojego zespołu. Customization obejmuje konfigurację projektu, niestandardowe schematy i kontekst współdzielony.

Coś się zepsuło. Troubleshooting zbiera awarie, z którymi ludzie faktycznie się borykają, wraz z poprawkami.

Cała mapa ​

Zacznij tutaj ​

Używaj codziennie ​

Zrozum to dogłębnie ​

Spraw to swoim ​

Gdy potrzebujesz pomocy ​

Koordynuj między repozytoriami (beta) ​

Wersja trzydziestosekundowa ​

1. Install        npm install -g @fission-ai/openspec@latest
2. Initialize     cd your-project && openspec init
3. Explore        (w swoim czacie AI)  /opsx:explore           ← opcjonalnie, ale świetny nawyk
4. Propose        (w swoim czacie AI)  /opsx:propose add-dark-mode
5. Build          (w swoim czacie AI)  /opsx:apply
6. Archive        (w swoim czacie AI)  /opsx:archive

Kroki 1 i 2 odbywają się w Twoim terminalu. Reszta dzieje się w czacie Twojego asystenta AI. Ten podział jest rzeczą wartą zapamiętania, a How Commands Work wyjaśnia dokładnie dlaczego. Krok 3 jest opcjonalny, ale rozpoczęcie od /opsx:explore, gdy nie jesteś pewien, to nawyk najbardziej godny pielęgnowania.

Gdzie jeszcze szukać pomocy ​

• Discord: discord.gg/YctCnvvshC w sprawie pytań, pomysłów i pomocy.
• GitHub Issues: github.com/Fission-AI/OpenSpec/issues w sprawie błędów i próśb o funkcje.
• openspec feedback "twoja wiadomość" wysyła informację zwrotną prosto z Twojego terminala (otwiera błąd na GitHubie).

Znalazłeś coś w tej dokumentacji, co jest nieprawidłowe, przestarzałe lub mylące? To jest błąd. Otwórz zgłoszenie lub PR. Ulepszenia dokumentacji to jedne z najbardziej wartościowych wkładów, jakie możesz wnieść.