Önce Spesifikasyon İş Akışı
Kod yazmadan önce gereksinimleri tanımlayın.
Hoş geldiniz. Bu, OpenSpec ile ilgili her şeyin bulunduğu ana sayfadır.
OpenSpec, sizin ve yapay zeka kodlama asistanınızın herhangi bir kod yazılmadan önce ne yapacağınıza anlaşmasına yardımcı olur. Değişikliği siz tanımlarsınız, yapay zeka kısa bir spesifikasyon ve görev listesi hazırlar, her ikiniz de aynı planı incelersiniz ve ardından çalışma başlar. Artık çalışmanın ortasında yapay zekanın yanlış şey yaptığını keşfetmek yok.
Eğer başka hiçbir şey okumazsanız, bu iki sayfayı okuyun:
/opsx:propose komutunu aslında nereye yazacağınız (ipucu: yapay zeka sohbetine, terminale değil). Bu, neredeyse herkesi bir kez yanıltır.İkincisi, göründüğünden daha önemli. OpenSpec'in iki ayrı kısmı var: terminalde çalıştırdığınız bir komut satırı aracı ve yapay zeka asistanınıza verdiğiniz eğik çizgi komutları (slash commands). Hangisinin hangisi olduğunu bilmek, en yaygın kafa karışıklığını önler.
İlk olarak edinmeniz gereken en iyi alışkanlık: ne yapacağınızdan emin değilseniz,
/opsx:exploreile başlayın. Kod veya herhangi bir ürün ortaya çıkmadan önce kodunuzu okuyan, seçenekleri değerlendiren ve bulanık bir fikri somut bir plana dönüştüren, hiçbir riski olmayan bir düşünme ortağıdır. Önce Keşfet rehberi bunu açıklar.
Yeni başlıyorsunuz. Başla ile başlayın, ardından Temel Kavramlara Genel Bakış sayfasına göz atın. Bir şey gizli gelirse, SSS ve Sözlük sayfaları yanınızda.
Sorununuz var ama henüz bir planınız yok. Bu en yaygın durumdur ve ona özel bir çözüm var: Önce Keşfet. Herhangi bir şeye başlamadan önce fikri yapay zeka ile birlikte düşünmek için /opsx:explore komutunu kullanın.
Büyük mevcut bir kod tabanınız var. Tümünü belgelemek zorunda değilsiniz. Mevcut Projede OpenSpec Kullanımı sayfası, okyanusu kaynatmadan gerçek, brownfield kod üzerinde nasıl başlayacağınızı gösterir.
Sadece çalışır hale getirmek istiyorum. Kurulum sayfasını okuyun, openspec init komutunu çalıştırın, ardından ilk eğik çizgi komutunuzu doğru yere yazmak için Komutlar Nasıl Çalışır sayfasını okuyun.
Örneklerle öğrenmeyi tercih ediyorum. Örnekler ve Tarifler sayfası, gerçek değişiklikleri baştan sona anlatır: küçük bir özellik, hata düzeltmesi, yeniden düzenleme, keşif.
Yapay zeka sadece bir plan hazırladı — şimdi ne olacak? Onu okuyun. Değişikliği İnceleme sayfası, hala ucuzken yanlış bir yolu yakalayan iki dakikalık inceleme sürecini gösterir ve İyi Spesifikasyonlar Yazma sayfası, onaylanmaya değer bir planın neyden oluştuğunu kapsar.
Takımda çalışıyorum. Takımda OpenSpec sayfası, bir değişikliğin bir dal ve bir çekme isteğine (pull request) nasıl dönüştüğünü ve takım arkadaşlarının koddan önce bir planı nasıl incelediğini gösterir.
Eski iş akışından geliyorum. Geçiş Rehberi sayfası, neyin değiştiğini ve nedenini açıklar ve mevcut çalışmalarınızın güvende olduğunu taahhüt eder.
Takımımın sürecine uyarlamak istiyorum. Özelleştirme sayfası, proje yapılandırmasını, özel şemaları ve paylaşılan bağlamı kapsar.
Bir şeyler bozuk. Sorun Giderme sayfası, insanların gerçekten karşılaştığı hataları ve çözümlerini toplar.
| Belge | Size Ne Sunar? |
|---|---|
| Başla | Kurulum yapma, başlatma ve ilk değişikliğinizi uçtan uca çalıştırma |
| Önce Keşfet | Herhangi bir şeye başlamadan önce bir fikri düşünmek için /opsx:explore kullanımı |
| Komutlar Nasıl Çalışır | Eğik çizgi komutlarının nerede çalıştığı, "etkileşimli mod"un ne anlama geldiği, terminal ile sohbet arasındaki fark |
| Temel Kavramlara Genel Bakış | Tek sayfada tüm zihinsel model: spesifikasyonlar, değişiklikler, deltalar, arşiv |
| Kurulum | npm, pnpm, yarn, bun, Nix ve kurulumun doğru çalıştığını nasıl doğrulayacağınız |
| Belge | Size Ne Sunar? |
|---|---|
| İş Akışları | Yaygın kalıplar ve her komuta ne zaman başvurulacağı |
| Örnekler ve Tarifler | Gerçek değişikliklerin tam adım adım anlatımları, kopyala-yapıştırılabilir |
| İyi Spesifikasyonlar Yazma | Güçlü bir gereksinimin ve senaryonun nasıl göründüğü ve bir değişikliği doğru boyutta nasıl yapacağınız |
| Değişikliği İnceleme | Herhangi bir kod yazılmadan önce hazırlanan bir plan üzerinde yapılan iki dakikalık inceleme |
| Takımda OpenSpec | Değişikliklerin dallar, çekme istekleri ve incelemelere nasıl uyarlanacağı |
| Mevcut Projede OpenSpec Kullanımı | Büyük bir brownfield kod tabanında OpenSpec'i benimseme |
| Değişikliği Düzenleme ve İyileştirme | Ürünleri güncelleme, geri dönme, elle yapılan düzenlemeleri uzlaştırma |
| Komutlar | Her /opsx:* eğik çizgi komutu için referans |
| CLI | Her openspec terminal komutu için referans |
| Belge | Size Ne Sunar? |
|---|---|
| Kavramlar | Spesifikasyonlar, değişiklikler, ürünler, şemalar ve arşiv için uzun açıklamalar |
| OPSX İş Akışı | İş akışının neden aşamalı kilitli değil de akışkan olduğu, artı bir mimari derinlemesine incelemesi |
| Sözlük | Tüm terimlerin tek bir yerde tanımlanması |
| Belge | Size Ne Sunar? |
|---|---|
| Özelleştirme | Proje yapılandırması, özel şemalar, paylaşılan bağlam |
| Çoklu Dil Desteği | İngilizce dışındaki dillerde ürün oluşturma |
| Desteklenen Araçlar | OpenSpec'in entegre olduğu 25'ten fazla AI aracı ve dosyaların nereye kaydedileceği |
| Belge | Size Ne Sunar? |
|---|---|
| SSS | En çok sorulan sorulara hızlı cevaplar |
| Sorun Giderme | Somut hatalar için somut çözümler |
| Geçiş Rehberi | Eski iş akışından OPSX'ye geçiş |
| Belge | Size Ne Sunar? |
|---|---|
| Mağazalar: Kullanıcı Rehberi | Çalışmanız birden fazla depo veya takımı kapsadığında planı kendi deposunda tutma |
| Aracı Sözleşmesi | Aracıların sürdürdüğü makine okunabilir CLI yüzeyleri |
1. Kurulum npm install -g @fission-ai/openspec@latest
2. Başlatma cd your-project && openspec init
3. Keşfet (in your AI chat) /opsx:explore ← isteğe bağlıdır, ancak edinmeniz gereken en iyi alışkanlıktır
4. Öner (in your AI chat) /opsx:propose add-dark-mode
5. Oluştur (in your AI chat) /opsx:apply
6. Arşivle (in your AI chat) /opsx:archive/opsx:explore ile başlamak, edinmeniz en değerli alışkanlıktır.openspec feedback "mesajınız" komutu, terminalinizden doğrudan geri bildirim gönderir (bir GitHub sorunu açar).Bu dokümanlarda yanlış, güncel olmayan veya kafa karıştırıcı bir şey buldunuz? Bu bir hatadır. Bir sorun veya bir çekme isteği (PR) açın. Dokümantasyon iyileştirmeleri, yapabileceğiniz en değerli katkılardan bazılarıdır.