Alur Kerja Spesifikasi Terlebih Dahulu
Tentukan persyaratan sebelum menulis kode.
OpenSpecPengembangan Berbasis Spesifikasi untuk Asisten AI
Spesifikasi ringan untuk membangun dan mengelola proyek asisten AI.
Selamat datang. Ini adalah rumah untuk segala hal tentang OpenSpec.
OpenSpec membantu Anda dan asisten coding AI Anda sepakat tentang apa yang akan dibangun sebelum ada kode yang ditulis. Anda menjelaskan perubahan yang diinginkan, AI membuat draf spesifikasi singkat dan daftar tugas, Anda berdua melihat rencana yang sama, kemudian pekerjaan dimulai. Tidak ada lagi penemuan di tengah jalan bahwa AI telah membangun hal yang salah.
Jika Anda tidak bisa membaca yang lain, baca dua halaman ini:
/opsx:propose (petunjuk: di chat AI Anda, bukan di terminal). Ini membuat hampir semua orang tersandung setidaknya sekali.Yang kedua itu lebih penting daripada yang terlihat. 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 akan menyelamatkan Anda dari kebingungan yang paling umum terjadi.
Kebiasaan terbaik yang harus dibangun terlebih dahulu: ketika Anda tidak yakin harus membangun apa, mulailah dengan
/opsx:explore. Ini adalah mitra berpikir tanpa risiko yang membaca kode Anda, menimbang pilihan, dan mengasah ide yang kabur menjadi rencana konkret sebelum ada artefak atau kode yang dibuat. Panduan Jelajahi Terlebih Dahulu menjelaskan mengapa.
Saya sama sekali baru. Mulailah dengan Memulai, kemudian lihat sekilas Konsep Inti dalam Sekilas. Ketika ada yang terasa misterius, FAQ dan Glosarium ada di dekat Anda.
Saya punya masalah tapi tidak punya rencana. Ini adalah kasus yang umum, dan ada jawaban khusus untuknya: Jelajahi Terlebih Dahulu. Gunakan /opsx:explore untuk memikirkan masalah itu bersama AI sebelum berkomitmen pada apapun.
Saya punya basis kode besar yang sudah ada. Anda tidak perlu mendokumentasikan semuanya. Menggunakan OpenSpec di Proyek yang Sudah Ada menunjukkan cara memulai dengan kode brownfield yang nyata tanpa harus mengerjakan seluruhnya sekaligus yang membutuhkan usaha besar.
Saya hanya ingin membuatnya berjalan. Instal, jalankan openspec init, kemudian baca Cara Perintah Bekerja agar perintah slash pertama Anda masuk ke tempat yang benar.
Saya belajar dengan contoh. Halaman Contoh & Resep memandu perubahan nyata dari awal sampai akhir: fitur kecil, perbaikan bug, refaktor, dan eksplorasi.
AI baru saja membuat draf rencana — sekarang apa? Baca rencana tersebut. Meninjau Perubahan menunjukkan tinjauan dua menit yang bisa menangkap kesalahan arah ketika biayanya masih murah, dan Menulis Spesifikasi yang Baik membahas apa yang membuat rencana layak disetujui.
Saya bekerja di tim. OpenSpec di Tim menunjukkan bagaimana perubahan dipetakan ke cabang dan pull request, serta bagaimana anggota tim meninjau rencana sebelum kode ditulis.
Saya datang dari alur kerja lama. Panduan Migrasi menjelaskan apa yang berubah dan mengapa, serta menjamin bahwa 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 kesalahan yang benar-benar dihadapi orang-orang, beserta perbaikannya.
| Dokumen | Apa yang Anda dapatkan |
|---|---|
| Memulai | Instal, inisialisasi, dan jalankan perubahan pertama Anda dari awal sampai akhir |
| Jelajahi Terlebih Dahulu | Gunakan /opsx:explore untuk memikirkan sebuah ide sebelum Anda berkomitmen |
| Cara Perintah Bekerja | Tempat perintah slash dijalankan, arti dari "mode interaktif", perbandingan terminal dan chat |
| Konsep Inti dalam Sekilas | Seluruh model mental dalam satu halaman: spesifikasi, perubahan, delta, arsip |
| Instalasi | npm, pnpm, yarn, bun, Nix, dan cara memverifikasi bahwa instalasi berhasil |
| Dokumen | Apa yang Anda dapatkan |
|---|---|
| Alur Kerja | Pola umum dan kapan menggunakan setiap perintah |
| Contoh & Resep | Panduan lengkap perubahan nyata, bisa disalin dan ditempel |
| Menulis Spesifikasi yang Baik | Bentuk dari persyaratan dan skenario yang kuat, serta cara menentukan ukuran perubahan yang tepat |
| Meninjau Perubahan | Tinjauan dua menit terhadap rencana draf sebelum ada kode yang ditulis |
| OpenSpec di Tim | Bagaimana perubahan sesuai dengan cabang, pull request, dan proses peninjauan |
| Menggunakan OpenSpec di Proyek yang Sudah Ada | Mengadopsi OpenSpec pada basis kode brownfield yang besar |
| Mengedit & Mengulangi Perubahan | Memperbarui artefak, kembali ke tahap sebelumnya, menyesuaikan 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 ini fleksibel bukan fase yang dikunci, serta penjelasan arsitektur yang mendalam |
| Glosarium | Setiap istilah didefinisikan di satu tempat |
| Dokumen | Apa yang Anda dapatkan |
|---|---|
| Kustomisasi | Konfigurasi proyek, skema kustom, konteks bersama |
| Multi-Bahasa | Hasilkan artefak dalam bahasa selain Inggris |
| Alat yang Didukung | Lebih dari 25 alat AI yang terintegrasi dengan OpenSpec, dan tempat file disimpan |
| Dokumen | Apa yang Anda dapatkan |
|---|---|
| FAQ | Jawaban cepat untuk pertanyaan yang paling banyak diajukan |
| Pemecahan Masalah | Perbaikan konkret untuk kesalahan konkret |
| Panduan Migrasi | Beralih dari alur kerja lama ke OPSX |
| Dokumen | Apa yang Anda dapatkan |
|---|---|
| Stores: Panduan Pengguna | Buat rencana di repo sendiri ketika pekerjaan Anda mencakup banyak repo atau tim |
| Kontrak Agen | Antarmuka CLI yang dapat dibaca mesin yang diakses oleh agen |
1. Instal npm install -g @fission-ai/openspec@latest
2. Inisialisasi cd your-project && openspec init
3. Jelajahi (di chat AI Anda) /opsx:explore ← opsional, tetapi kebiasaan yang sangat bagus
4. Ajukan (di chat AI Anda) /opsx:propose add-dark-mode
5. Bangun (di chat AI Anda) /opsx:apply
6. Arsipkan (di chat AI Anda) /opsx:archiveLangkah 1 dan 2 dilakukan di terminal Anda. Sisanya dilakukan di chat asisten AI Anda. Pemisahan itu adalah satu hal yang layak dihafal, dan Cara Perintah Bekerja menjelaskan mengapa secara tepat. Langkah 3 adalah opsional, tetapi memulai dengan /opsx:explore ketika Anda tidak yakin adalah kebiasaan yang paling layak dibentuk.
openspec feedback "pesan Anda" mengirimkan umpan balik langsung dari terminal Anda (ini akan membuka isu GitHub).Menemukan sesuatu di dokumen ini yang salah, usang, atau membingungkan? Itu adalah bug. Buka isu atau PR. Peningkatan dokumentasi adalah salah satu kontribusi yang paling berharga yang dapat Anda berikan.