OpenSpec Belgeleme ​

Hoş geldiniz. Bu, OpenSpec ile ilgili her şeyin merkezi.

OpenSpec, siz ve AI kodlama asistanınızın herhangi bir kod yazılmadan önce ne inşa edileceği konusunda anlaşmasını sağlar. Değişikliği tanımlarsınız, AI kısa bir spesifikasyon ve görev listesi taslaklar, her ikiniz de aynı plana bakarsınız ve ardından iş başlar. Artık işin yarısında AI'ın yanlış şeyi inşa ettiğini keşfetmek yok.

Başka hiçbir şey okumayacaksanız, bu iki sayfayı okuyun:

1. Başlangıç: kurulum, başlatma ve ilk değişikliğinizi gönderme.
2. Komutlar Nasıl Çalışır: /opsx:propose komutunu nerede yazacağınız (ipucu: AI sohbetinizde, terminalde değil). Bu, neredeyse herkesi bir kez yanıltır.

İkinci sayfa göründüğünden daha önemli. OpenSpec'in iki yarısı var: terminalde çalıştırdığınız bir komut satırı aracı ve AI asistanınıza verdiğiniz slash komutları. Hangisinin hangisi olduğunu bilmek, en yaygın kafa karışıklığı anını önler.

Öncelikle edinmeniz gereken en iyi alışkanlık: ne inşa edeceğinizden emin olmadığınızda /opsx:explore ile başlayın. Bu, kodunuzu okuyan, seçenekleri değerlendiren ve herhangi bir artefakt veya kod var olmadan bulanık bir fikri somut bir plana dönüştüren riski düşük bir düşünce ortağıdır. Önce Keşfet rehberi bunu açıklar.

Yolunuzu seçin ​

Tamamen yeni başlıyorum. Başlangıç ile başlayın, ardından Temel Kavramlara Genel Bakış'ı göz atın. Bir şey gizemli geliyorsa, SSS ve Terimler Sözlüğü yakında.

Bir sorunum var ama planım yok. Bu yaygın durum ve özel bir cevabı var: Önce Keşfet. Herhangi bir şeye karar vermeden önce AI ile düşünmek için /opsx:explore kullanın.

Büyük bir mevcut kod tabanım var. Hepsini belgelemeniz gerekmez. Mevcut Bir Projede OpenSpec Kullanımı, okyanusu kaynatmadan gerçek, brownfield kod üzerinde nasıl başlanacağını gösterir.

Sadece çalışmasını istiyorum. Kurulum, openspec init çalıştırın, ardından ilk slash komutunuzun doğru yere ulaşması için Komutlar Nasıl Çalışır'ı okuyun. Ya da kurulumu AI destekli kurulum istemi ile asistanınıza devredin.

Örnek üzerinden öğrenirim. Örnekler ve Tarifler sayfası, gerçek değişiklikleri baştan sona anlatır: küçük bir özellik, bir hata düzeltmesi, bir yeniden yapılandırma, bir keşif.

AI bir plan taslakladı — şimdi ne olacak? Okuyun. Bir Değişikliği İnceleme, kod yazılmadan önce yanlış bir dönüşü yakalayan iki dakikalık incelemeyi gösterir ve İyi Spesifikasyonlar Yazma, onaylanmaya değer bir planın nelerden oluştuğunu kapsar.

Bir ekipte çalışıyorum. Ekipte OpenSpec, bir değişikliğin nasıl bir branch ve pull request'e karşılık geldiğini ve ekip arkadaşlarının kod öncesinde planı nasıl incelediğini gösterir.

Eski iş akışından geliyorum. Geçiş Rehberi, ne değiştiğini ve nedenini açıklar ve mevcut çalışmalarınızın güvende olduğunu garanti eder.

Ekip sürecime göre şekillendirmek istiyorum. Özelleştirme, proje yapılandırması, özel şemalar ve paylaşılan bağlamı kapsar.

Bir şey bozuk. Sorun Giderme, insanların gerçekten karşılaştığı hataları ve düzeltmelerini toplar.

Tüm harita ​

Buradan başlayın ​

Günlük kullanımda ​

Derinlemesine anlayın ​

Kendi yapınıza uydurun ​

Yardım gerektiğinde ​

Repo'lar arası koordinasyon (beta) ​

Otuz saniyelik versiyon ​

1. Kurulum        npm install -g @fission-ai/openspec@latest
2. Başlatma       cd your-project && openspec init
3. Keşfet         (AI sohbetinizde)  /opsx:explore           ← isteğe bağlı, ama harika bir alışkanlık
4. Öner           (AI sohbetinizde)  /opsx:propose add-dark-mode
5. İnşa Et        (AI sohbetinizde)  /opsx:apply
6. Arşivle        (AI sohbetinizde)  /opsx:archive

1 ve 2. adımlar terminalde gerçekleşir. Geri kalanı AI asistanınızın sohbetinde gerçekleşir. Bu ayrım, ezberlemeye değer tek şeydir ve Komutlar Nasıl Çalışır tam olarak nedenini açıklar. 3. adım isteğe bağlıdır, ama emin olmadığınızda /opsx:explore ile başlamak en çok edinmeye değer alışkanlıktır.

Başka nerede yardım alabilirsiniz ​

• Discord: Sorular, fikirler ve yardım için discord.gg/YctCnvvshC.
• GitHub Issues: Hatalar ve özellik talepleri için github.com/Fission-AI/OpenSpec/issues.
• openspec feedback "your message" geri bildirimi doğrudan terminalinizden gönderir (bir GitHub issue açar).

Bu belgelerde yanlış, eski veya kafa karıştırıcı bir şey mi buldunuz? Bu bir hatadır. Bir issue veya PR açın. Belgeleme iyileştirmeleri, yapabileceğiniz en değerli katkılardan bazılarıdır.