Dokumentasi Developer

SpecKit Documentation

Pelajari cara menyusun, merancang, dan menyinkronkan dokumen spesifikasi teknis dengan AI.

1. Pendahuluan

1. Pendahuluan

SpecKit adalah platform kecerdasan buatan (AI) terstruktur yang dirancang khusus untuk mempercepat rekayasa persyaratan dan arsitektur perangkat lunak. Dibangun untuk menjembatani kesenjangan komunikasi antara tim produk (Product Managers) dan tim pengembang (Engineers) sebelum satu baris kode pun ditulis.

Fokus Utama

Masalah yang Kami Selesaikan

Dokumentasi spesifikasi (PRD) yang tidak teratur, skema database yang tidak sinkron dengan dokumentasi API, dan kesalahpahaman fitur yang mengakibatkan pengerjaan ulang (rework) kode.

Pendekatan Baru

Solusi dari SpecKit

Dokumen terstruktur Markdown (.md) yang terintegrasi secara modular. Setiap perubahan dianalisis dampaknya dan diperbarui secara sinkron oleh mesin AI.

Mengapa Perencanaan itu Penting?Menurut survei industri, lebih dari 60% kegagalan proyek disebabkan oleh kesalahan analisis kebutuhan fungsional. Merancang blueprint terlebih dahulu menghemat hingga 40% waktu implementasi kode.

2. Memilih Tech Stack

Saat membuat Technical Blueprint baru, Anda diharuskan memilih tumpukan teknologi (Tech Stack) yang akan digunakan. Pilihan stack ini secara dinamis mengonfigurasi format dan tipe data dari dokumentasi teknis yang dihasilkan.

Pilihan StackDampak ke Dokumen
PostgreSQL / MySQLMenghasilkan skema database relasional (SQL DDL) lengkap dengan relasi Foreign Key.
MongoDBMenghasilkan format skema dokumen JSON / Mongoose Schema untuk database NoSQL.
Next.js / Vite (React)Menyusun peta fungsionalitas antarmuka (Client UI Routing) dan state management.
Stripe / MidtransMenghasilkan spesifikasi endpoint webhook pembayaran dan alur verifikasi transaksi.
Tipe Data Sesuai KonvensiAI kami menguji data type secara ketat. Jika Anda memilih Node.js + MongoDB, tipe data dalam database schema akan ditulis dalam format JavaScript/Mongoose. Jika memilih Go + PostgreSQL, maka akan ditulis dalam tipe data SQL standar.

3. Sesi Wawancara AI

Anda tidak perlu menulis dokumen yang rumit dari awal. SpecKit menggunakan pendekatan wawancara interaktif adaptif. AI bertindak sebagai analis sistem yang menggali informasi inti proyek Anda secara bertahap.

01

Jelaskan Ide Utama Anda

Cukup berikan deskripsi singkat seperti: 'Aplikasi e-commerce baju anak dengan sistem langganan'.

02

Jawab Pertanyaan AI

AI akan mengajukan 3-5 pertanyaan terfokus (misal: 'Bagaimana metode autentikasinya?', 'Apakah perlu integrasi multi-tenant?'). Jawablah dengan bahasa alami Anda sendiri.

03

Hasilkan Dokumen Sinkron

AI memproses semua jawaban Anda dan menyusun 4 dokumen utama: PRD (Spesifikasi Kebutuhan), DB Schema (Skema Data), API Spec (Spesifikasi Endpoint), dan Roadmap (Peta Rencana Kerja) sekaligus.

4. Analisis Dampak Otomatis

Ini adalah salah satu fitur paling istimewa di SpecKit. Pada pengembangan software tradisional, ketika rencana produk berubah, dokumen teknis seperti rancangan database dan spesifikasi API seringkali lupa diperbarui sehingga menjadi usang. Fitur Analisis Dampak (Impact Analysis) hadir untuk menyinkronkan semuanya secara otomatis.

Cara Kerja Aliran:
STEP 01
Ubah Kebutuhan
Anda menambahkan kebutuhan baru: 'User dapat mengunggah foto profil/avatar' ke dalam dokumen fitur (REQUIREMENTS.md).
STEP 02
Analisis Dampak
AI SpecKit langsung mendeteksi: 'Fitur ini membutuhkan penyimpanan URL avatar, serta API endpoint untuk memproses upload.'
STEP 03
Pembaruan Sinkron
Secara otomatis, AI menyisipkan kolom 'avatar_url' ke dokumen database (DB.md) dan endpoint '/api/user/avatar' ke dokumen API (API.md).
Keuntungan Utama:Anda tidak perlu lagi menulis ulang spesifikasi database atau endpoint API secara manual satu per satu setiap kali ada perubahan ide bisnis. Semua dokumen teknis Anda di SpecKit dijamin selalu sinkron dan konsisten.

5. Integrasi & Ekspor Git

SpecKit menganut prinsip 'Docs as Code'. Dokumen cetak biru Anda dihasilkan dalam format Markdown (.md) murni standar industri, mempermudah integrasi langsung ke dalam workflow kontrol versi Git Anda.

Rekomendasi Struktur Proyek

my-software-project/
├── src/
├── public/
├── docs/(Subdirektori SpecKit)
REQUIREMENTS.md(PRD & Kebutuhan Fitur)
DB.md(Skema & Struktur Tabel)
API.md(Spesifikasi Endpoint)
ROADMAP.md(Peta Implementasi Proyek)
├── package.json
└── README.md

Cara Mengekspor:

01.

Di Editor SpecKit, klik tombol 'Download Archive' (.zip) di pojok kanan atas.

02.

Ekstrak isi folder tersebut ke dalam direktori proyek Anda (misalnya di dalam subfolder `/docs` atau langsung di root folder).

03.

Lakukan push ke GitHub, GitLab, atau Bitbucket. Markdown SpecKit ter-render indah dengan format kaya di semua platform Git.