OpenSpec Dokümantasyonu ​

Hoş geldiniz. Burası OpenSpec ile ilgili her şeyin ana sayfasıdır.

OpenSpec, herhangi bir kod yazılmadan önce yapılması gerekenler konusunda sizin ve Yapay Zeka (AI) kodlama asistanınızın anlaşmasını sağlar. Değişikliği siz tanımlarsınız, AI kısa bir spesifikasyon ve bir görev listesi taslağı hazırlar, ikiniz de aynı planı incelersiniz ve ardından çalışma gerçekleşir. Yarı yolda yapay zekanın yanlış bir şey inşa ettiğini keşfetme derdi kalmaz.

Başka hiçbir şeyi okumazsanız, bu iki sayfayı okuyun:

1. Getting Started: kurulum, başlatma ve ilk değişikliğinizi yayınlama.
2. How Commands Work: /opsx:propose komutunu nerede yazdığınız (ipucu: terminalde değil, AI sohbetinizde). Bu neredeyse herkesin bir kez takıldığı yerdir.

İkinci olanı göründüğünden daha önemlidir. OpenSpec iki yarımden oluşur: terminalinizde çalıştırdığınız bir komut satırı aracı ve Yapay Zeka asistanınıza verdiğiniz eğik (slash) komutlar. Hangisinin hangisi olduğunu bilmek, en yaygın kafa karışıklığı anını ortadan kaldırır.

İlk oluşturulması gereken en iyi alışkanlık: ne inşa edeceğinizden emin değilseniz /opsx:explore ile başlayın. Bu, kodunuzu okuyan, seçenekleri tartarak belirsiz bir fikri herhangi bir çıktı veya kod var olmadan somut bir plana dönüştüren risksiz bir düşünce ortağıdır. Explore First rehberi bu durumu açıklar.

Yolunuzu Seçin ​

Tamamen yeni gibiyim. Getting Started ile başlayın, ardından Core Concepts at a Glance'yi hızlıca gözden geçirin. Bir şey gizemli gelirse, FAQ ve Glossary yakındadır.

Bir sorunum var ama bir planım yok. Bu yaygın durumdur ve özel bir cevabı vardır: Explore First. Herhangi bir şeye taahhütte bulunmadan önce AI ile düşünmek için /opsx:explore kullanın.

Büyük, mevcut bir kod tabanım var. Tümünü dokümante etmenize gerek yok. Using OpenSpec in an Existing Project, okyanusu kaynatmadan gerçek, eski (brownfield) kod üzerinde nasıl başlayacağınızı gösterir.

Sadece çalışır hale getirmek istiyorum. Install'ı okuyun, openspec init komutunu çalıştırın ve ilk eğik komutunuzun doğru yere düşmesi için How Commands Work'yi okuyun.

Örneklerle öğreniyorum. Examples & Recipes sayfası gerçek değişiklikleri baştan sona anlatır: küçük bir özellik, bir hata düzeltmesi, yeniden yapılandırma (refactor), bir keşif.

Eski iş akışından geliyorum. Migration Guide, neyin ve neden değiştiğini açıklar ve mevcut çalışmanızın güvende olduğunu vaat eder.

Bunu ekibimin sürecine uyarlamak istiyorum. Customization, proje yapılandırmasını, özel şemaları ve paylaşılan bağlamı kapsar.

Bir şey bozuldu. Troubleshooting, insanların gerçekten karşılaştığı hataları düzeltmeleriyle birlikte toplar.

Bütün Harita ​

Buradan başlayın ​

Günlük kullanımda kullanın ​

Derinlemesine anlayın ​

Kendinize uyarlayın ​

Yardım gerektiğinde ​

Depolar arasında koordinasyon (beta) ​

Otuz Saniyelik Versiyon ​

1. Install        npm install -g @fission-ai/openspec@latest
2. Initialize     cd your-project && openspec init
3. Explore        (in your AI chat)  /opsx:explore           ← isteğe bağlı, ama harika bir alışkanlık
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:archive

Adım 1 ve 2 terminalinizde gerçekleşir. Geri kalanı Yapay Zeka asistanınızın sohbetinde gerçekleşir. Bu ayrım akılda tutulması gereken tek şeydir ve How Commands Work tam olarak nedenini açıklar. Adım 3 isteğe bağlıdır, ancak emin olmadığınız bir durumda /opsx:explore ile başlamak en çok fayda sağlayan alışkanlıktır.

Nereden daha yardım alabilirsiniz? ​

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

Bu dokümanlarda yanlış, eskimiş veya kafa karıştırıcı bir şey mi buldunuz? Bu bir hatadır. Bir sorun veya PR açın. Dokümantasyon iyileştirmeleri yapabileceğiniz en değerli katkılardan bazılarıdır.