Alur Kerja Berbasis Spesifikasi
Tentukan persyaratan sebelum menulis kode.
OpenSpecPengembangan Berbasis Spesifikasi untuk Asisten AI
Spesifikasi ringan untuk membangun dan mengelola proyek asisten AI.
Spesifikasi ringan untuk membangun dan mengelola proyek asisten AI.
Selamat datang. Ini adalah pusat untuk segala hal terkait OpenSpec.
OpenSpec membantu Anda dan asisten coding AI Anda sepakat tentang apa yang akan dibangun sebelum kode ditulis. Anda mendeskripsikan perubahan, AI membuat draf spesifikasi singkat dan daftar tugas, Anda berdua melihat rencana yang sama, lalu pekerjaan dilakukan. Tidak ada lagi kejutan di tengah jalan bahwa AI membangun sesuatu yang salah.
Jika Anda hanya membaca dua halaman ini:
/opsx:propose (petunjuk: di chat AI Anda, bukan di terminal). Ini membingungkan hampir semua orang sekali.Hal kedua ini lebih penting daripada kelihatannya. OpenSpec memiliki dua bagian: alat baris perintah yang Anda jalankan di terminal, dan perintah slash yang Anda berikan ke asisten AI Anda. Mengetahui mana yang mana menghemat momen kebingungan paling umum.
Kebiasaan terbaik untuk dibangun pertama: ketika Anda tidak yakin apa yang harus dibangun, mulailah dengan
/opsx:explore. Ini adalah mitra berpikir tanpa risiko yang membaca kode Anda, menimbang opsi, dan mengasah ide kabur menjadi rencana konkret sebelum artefak atau kode apa pun ada. Panduan Explore First menjelaskan alasannya.
Saya benar-benar baru. Mulai dengan Memulai, lalu baca sekilas Konsep Inti Sekilas. Ketika sesuatu terasa misterius, FAQ dan Glosarium ada di dekat Anda.
Saya punya masalah tapi belum punya rencana. Ini kasus yang umum, dan ada jawaban khusus: Explore First. Gunakan /opsx:explore untuk berpikir bersama AI sebelum berkomitmen pada apa pun.
Saya punya basis kode besar yang sudah ada. Anda tidak perlu mendokumentasikan semuanya. Menggunakan OpenSpec di Proyek yang Sudah Ada menunjukkan cara memulai pada kode brownfield nyata tanpa mendidihkan samudra.
Saya hanya ingin membuatnya bekerja. Instal, jalankan openspec init, lalu baca Cara Kerja Perintah agar perintah slash pertama Anda mendarat di tempat yang tepat. Atau serahkan setup ke asisten Anda dengan prompt instalasi yang dibantu AI.
Saya belajar dengan contoh. Halaman Contoh & Resep menjelaskan perubahan nyata dari awal hingga akhir: fitur kecil, perbaikan bug, refactoring, dan eksplorasi.
AI baru saja membuat draf rencana — lalu apa? Bacalah. Meninjau Perubahan menunjukkan pemeriksaan dua menit yang menangkap arah yang salah selagi masih murah, dan Menulis Spesifikasi yang Baik membahas apa yang membuat rencana layak disetujui.
Saya bekerja dalam tim. OpenSpec dalam Tim menunjukkan bagaimana perubahan dipetakan ke cabang dan pull request, dan bagaimana rekan tim meninjau rencana sebelum kode.
Saya datang dari alur kerja lama. Panduan Migrasi menjelaskan apa yang berubah dan mengapa, dan menjamin pekerjaan Anda yang sudah ada tetap aman.
Saya ingin menyesuaikannya dengan proses tim saya. Kustomisasi membahas konfigurasi proyek, skema kustom, dan konteks bersama.
Ada yang rusak. Pemecahan Masalah mengumpulkan kegagalan yang benar-benar dialami orang, lengkap dengan perbaikannya.
| Dokumen | Apa yang Anda dapatkan |
|---|---|
| Memulai | Instal, inisialisasi, dan jalankan perubahan pertama Anda dari awal hingga akhir |
| Explore First | Gunakan /opsx:explore untuk memikirkan ide sebelum Anda berkomitmen |
| Cara Kerja Perintah | Di mana perintah slash dijalankan, apa arti "mode interaktif", terminal vs chat |
| Konsep Inti Sekilas | Seluruh model mental dalam satu halaman: spesifikasi, perubahan, delta, arsip |
| Instalasi | npm, pnpm, yarn, bun, Nix, prompt yang menyerahkan setup ke asisten AI Anda, dan cara memverifikasi berhasil |
| Dokumen | Apa yang Anda dapatkan |
|---|---|
| Alur Kerja | Pola umum dan kapan menggunakan setiap perintah |
| Contoh & Resep | Penjelasan lengkap perubahan nyata, siap salin-tempel |
| Menulis Spesifikasi yang Baik | Bagaimana persyaratan dan skenario yang kuat terlihat, dan cara menyesuaikan ukuran perubahan |
| Meninjau Perubahan | Pemeriksaan dua menit pada rencana yang sudah dibuat sebelum kode ditulis |
| OpenSpec dalam Tim | Bagaimana perubahan cocok dengan cabang, pull request, dan peninjauan |
| Menggunakan OpenSpec di Proyek yang Sudah Ada | Mengadopsi OpenSpec pada basis kode brownfield besar |
| Mengedit & Mengiterasi Perubahan | Perbarui artefak, mundur, rekonsiliasi edit manual |
| Perintah | Referensi untuk setiap perintah slash /opsx:* |
| CLI | Referensi untuk setiap perintah terminal openspec |
| Dokumen | Apa yang Anda dapatkan |
|---|---|
| Konsep | Penjelasan panjang tentang spesifikasi, perubahan, artefak, skema, dan arsip |
| Alur Kerja OPSX | Mengapa alur kerja bersifat cair bukan terkunci fase, plus penjelasan mendalam arsitektur |
| Glosarium | Setiap istilah didefinisikan di satu tempat |
| Dokumen | Apa yang Anda dapatkan |
|---|---|
| Kustomisasi | Konfigurasi proyek, skema kustom, konteks bersama |
| Multi-Bahasa | Buat artefak dalam bahasa selain Inggris |
| Alat yang Didukung | 30+ alat AI yang diintegrasikan OpenSpec, dan di mana file ditempatkan |
| Galeri Komunitas | Proyek dan sumber daya yang dibangun dengan dan untuk OpenSpec |
| Dokumen | Apa yang Anda dapatkan |
|---|---|
| FAQ | Jawaban cepat untuk pertanyaan yang paling sering diajukan |
| Pemecahan Masalah | Perbaikan konkret untuk kegagalan konkret |
| Panduan Migrasi | Berpindah dari alur kerja lama ke OPSX |
| Dokumen | Apa yang Anda dapatkan |
|---|---|
| Stores: Panduan Pengguna | Rencanakan di repo sendiri ketika pekerjaan Anda melintasi repo atau tim |
| Kontrak Agen | Permukaan CLI yang dapat dibaca mesin yang digerakkan agen |
1. Install npm install -g @fission-ai/openspec@latest
2. Initialize cd your-project && openspec init
3. Explore (di chat AI Anda) /opsx:explore ← opsional, tapi kebiasaan yang bagus
4. Propose (di chat AI Anda) /opsx:propose add-dark-mode
5. Build (di chat AI Anda) /opsx:apply
6. Archive (di chat AI Anda) /opsx:archiveLangkah 1 dan 2 terjadi di terminal Anda. Sisanya terjadi di chat asisten AI Anda. Pemisahan ini adalah satu hal yang layak dihafal, dan Cara Kerja Perintah menjelaskan persis mengapa. Langkah 3 opsional, tapi memulai dengan /opsx:explore ketika Anda tidak yakin adalah kebiasaan paling berharga untuk dibentuk.
openspec feedback "pesan Anda" mengirim umpan balik langsung dari terminal Anda (membuka issue GitHub).Menemukan sesuatu di dokumentasi ini yang salah, kedaluwarsa, atau membingungkan? Itu bug. Buka issue atau PR. Peningkatan dokumentasi adalah salah satu kontribusi paling berharga yang bisa Anda buat.