Alur Kerja Spec-First
Tentukan persyaratan sebelum menulis kode.
OpenSpecPengembangan Berbasis Spesifikasi untuk Asisten AI
Spek ringan untuk membangun dan mengelola proyek asisten AI.
Spek ringan untuk membangun dan mengelola proyek asisten AI.
Selamat datang. Ini adalah pusat dari segala hal tentang OpenSpec.
OpenSpec membantu Anda dan asisten pengkodean AI Anda sepakat tentang apa yang akan dibangun sebelum kode apa pun ditulis. Anda mendeskripsikan perubahannya, AI membuat draf spek singkat dan daftar tugas, Anda berdua melihat rencana yang sama, dan kemudian pekerjaan dilakukan. Tidak ada lagi penemuan di tengah jalan bahwa AI telah membangun hal yang salah.
Jika Anda tidak membaca hal lain, bacalah dua halaman ini:
/opsx:propose (petunjuk: di obrolan AI Anda, bukan terminal). Ini menjebak hampir semua orang sekali.Yang kedua lebih penting daripada kelihatannya. OpenSpec memiliki dua bagian: alat baris perintah yang Anda jalankan di terminal, dan perintah slash yang Anda berikan kepada asisten AI Anda. Mengetahui mana yang mana menghemat kebingungan paling umum.
Kebiasaan terbaik untuk dibangun pertama: ketika Anda tidak yakin apa yang akan dibangun, mulailah dengan
/opsx:explore. Ini adalah mitra berpikir tanpa risiko yang membaca kode Anda, menimbang opsi, dan mempertajam ide samar menjadi rencana konkret sebelum ada artefak atau kode yang ada. Panduan Explore First menyampaikannya.
Saya benar-benar baru. Mulailah dengan Getting Started, lalu baca sekilas Core Concepts at a Glance. Jika sesuatu terasa misterius, FAQ dan Glossary ada di dekatnya.
Saya punya masalah tetapi belum punya rencana. Ini adalah kasus yang umum, dan ini memiliki jawaban khusus: Explore First. Gunakan /opsx:explore untuk memikirkannya bersama AI sebelum berkomitmen pada apa pun.
Saya memiliki basis kode besar yang sudah ada. Anda tidak mendokumentasikan semuanya. Using OpenSpec in an Existing Project menunjukkan cara memulai pada kode brownfield yang nyata tanpa membuat masalah terlalu rumit.
Saya hanya ingin membuatnya berfungsi. Install, jalankan openspec init, lalu baca How Commands Work agar perintah slash pertama Anda mendarat di tempat yang benar.
Saya belajar dari contoh. Halaman Examples & Recipes memandu melalui perubahan nyata dari awal hingga akhir: fitur kecil, perbaikan bug, refactoring, eksplorasi.
Saya datang dari alur kerja lama. Migration Guide menjelaskan apa yang berubah dan mengapa, serta menjanjikan bahwa pekerjaan Anda yang sudah ada aman.
Saya ingin menyesuaikannya dengan proses tim saya. Customization mencakup konfigurasi proyek, skema kustom, dan konteks bersama.
Ada yang rusak. Troubleshooting mengumpulkan kegagalan yang benar-benar dialami orang, lengkap dengan perbaikannya.
| Doc | Apa yang diberikannya kepada Anda |
|---|---|
| Getting Started | Instalasi, inisialisasi, dan jalankan perubahan pertama Anda dari awal hingga akhir |
| Explore First | Gunakan /opsx:explore untuk memikirkan ide sebelum Anda berkomitmen |
| How Commands Work | Di mana perintah slash berjalan, apa arti "mode interaktif", terminal vs obrolan |
| Core Concepts at a Glance | Seluruh model mental dalam satu halaman: spek, perubahan, delta, arsip |
| Installation | npm, pnpm, yarn, bun, Nix, dan cara memverifikasi bahwa itu berhasil |
| Doc | Apa yang diberikannya kepada Anda |
|---|---|
| Workflows | Pola umum dan kapan harus menggunakan setiap perintah |
| Examples & Recipes | Panduan lengkap perubahan nyata, siap disalin-tempel |
| Using OpenSpec in an Existing Project | Mengadopsi OpenSpec pada basis kode brownfield yang besar |
| Editing & Iterating on a Change | Perbarui artefak, kembali, rekonsiliasi pengeditan manual |
| Commands | Referensi untuk setiap perintah slash /opsx:* |
| CLI | Referensi untuk setiap perintah terminal openspec |
| Doc | Apa yang diberikannya kepada Anda |
|---|---|
| Concepts | Penjelasan panjang tentang spek, perubahan, artefak, skema, dan arsip |
| OPSX Workflow | Mengapa alur kerja itu cair daripada terkunci fase, ditambah pendalaman arsitektur |
| Glossary | Setiap istilah yang didefinisikan di satu tempat |
| Doc | Apa yang diberikannya kepada Anda |
|---|---|
| Customization | Konfigurasi proyek, skema kustom, konteks bersama |
| Multi-Language | Menghasilkan artefak dalam bahasa selain Inggris |
| Supported Tools | 25+ alat AI yang diintegrasikan dengan OpenSpec, dan tempat berkas mendarat |
| Doc | Apa yang diberikannya kepada Anda |
|---|---|
| FAQ | Jawaban cepat untuk pertanyaan yang paling sering diajukan orang |
| Troubleshooting | Perbaikan konkret untuk kegagalan yang nyata |
| Migration Guide | Pindah dari alur kerja lama ke OPSX |
| Doc | Apa yang diberikannya kepada Anda |
|---|---|
| Stores: User Guide | Rencana di repo sendiri ketika pekerjaan Anda mencakup beberapa repos atau tim |
| Agent Contract | Permukaan CLI yang dapat dibaca mesin yang dikendalikan agen |
1. Install npm install -g @fission-ai/openspec@latest
2. Initialize cd your-project && openspec init
3. Explore (di obrolan AI Anda) /opsx:explore ← opsional, tetapi kebiasaan yang bagus
4. Propose (di obrolan AI Anda) /opsx:propose add-dark-mode
5. Build (di obrolan AI Anda) /opsx:apply
6. Archive (di obrolan AI Anda) /opsx:archiveLangkah 1 dan 2 terjadi di terminal Anda. Sisanya terjadi di obrolan asisten AI Anda. Perpecahan inilah yang layak diingat, dan How Commands Work menjelaskan mengapa secara tepat. Langkah 3 opsional, tetapi memulai dengan /opsx:explore ketika Anda tidak yakin adalah kebiasaan yang paling berharga untuk dibentuk.
openspec feedback "pesan Anda" mengirimkan umpan balik langsung dari terminal Anda (ini membuka isu GitHub).Menemukan sesuatu di dokumentasi ini yang salah, usang, atau membingungkan? Itu adalah bug. Buka isu atau PR. Peningkatan dokumentasi adalah beberapa kontribusi paling berharga yang dapat Anda buat.