Source code aplikasi, template web, dan ebook. Unduh dari akun setelah bayar. Lihat produk

Blog / Perencanaan / Checklist Sebelum Coding: Doku...
Perencanaan

Checklist Sebelum Coding: Dokumen Wajib untuk Membangun Aplikasi Web Berbasis Laravel

AD

Admin HijrahKreativa

Penulis

19 Oct 2026
12 min read
10 views

Overview

Masalah yang diselesaikan. Proyek web sering gagal bukan karena kode yang buruk, melainkan karena fondasinya tidak jelas: kebutuhan berubah-ubah di tengah jalan, fitur "tambahan kecil" yang tak ada habisnya, skema database yang dirombak berkali-kali, dan klien yang merasa hasilnya tidak sesuai harapan. Memulai php artisan make:model sebelum ada kesepakatan tertulis hampir selalu berakhir dengan pengerjaan ulang.

Hasil akhir: satu paket dokumen ringkas (bukan tumpukan dokumen tebal) yang cukup untuk memulai pengembangan dengan percaya diri, beserta templat siap pakai, checklist keputusan teknis khusus Laravel, dan struktur folder docs/ di repository.

Prinsip yang dipakai: dokumen secukupnya. Untuk proyek kecil, setiap dokumen bisa cukup satu halaman. Yang penting isinya terjawab dan disepakati.

Prerequisites

Kebutuhan

Keterangan

Akses ke pemangku kepentingan

Klien, pemilik produk, atau pengguna kunci untuk wawancara

Alat penulisan

Markdown di repository (disarankan), Google Docs, atau Notion

Alat diagram

Mermaid (di Markdown), draw.io, atau Figma untuk wireframe

Pengetahuan teknis

Dasar Laravel, database relasional, dan HTTP

Versi teknologi yang diperkirakan

PHP 8.3+, Laravel 13.x (atau 12.x), MySQL 8.x/MariaDB

Step-by-Step Tutorial

1. Gambaran Urutan Dokumen

1. Ringkasan Proyek & Tujuan      ──► mengapa proyek ini ada
2. Ruang Lingkup (In/Out Scope)   ──► batas pekerjaan
3. Peran Pengguna & User Story    ──► siapa melakukan apa
4. Alur Proses (Flow)             ──► langkah-langkah bisnis
5. Wireframe / Daftar Halaman     ──► tampilan kasar
6. ERD & Kamus Data               ──► rancangan database
7. Matriks Hak Akses              ──► siapa boleh apa
8. Spesifikasi API & Integrasi    ──► bila ada
9. Kebutuhan Non-Fungsional       ──► keamanan, performa, dll.
10. Rencana Teknis & Lingkungan   ──► stack, repo, deploy
11. Rencana Pengujian & DoD       ──► kapan dianggap selesai
12. Jadwal, Risiko, Anggaran      ──► rencana kerja
13. Kontrak & Serah Terima        ──► perjanjian tertulis

Struktur folder di repository:

docs/
├── 01-ringkasan-proyek.md
├── 02-ruang-lingkup.md
├── 03-user-story.md
├── 04-alur-proses.md
├── 05-wireframe/
├── 06-erd.md
├── 07-matriks-akses.md
├── 08-api-spec.yaml
├── 09-non-fungsional.md
├── 10-rencana-teknis.md
├── 11-rencana-test.md
├── 12-risiko-jadwal.md
└── adr/
    └── 0001-pilih-livewire-atau-blade.md

2. Dokumen 1: Ringkasan Proyek dan Tujuan

Jawab: masalah apa yang diselesaikan, untuk siapa, dan bagaimana tahu berhasil?

# Ringkasan Proyek

**Nama proyek:** Sistem Pre-Order Toko X
**Pemilik produk:** Nama, jabatan
**Tanggal mulai / target rilis:** ... / ...

## Masalah
Pesanan PO saat ini dicatat lewat chat dan spreadsheet. Sering terjadi stok melebihi
kuota, pelanggan lupa melunasi, dan rekap produksi memakan waktu setengah hari.

## Tujuan terukur
- Mengurangi waktu rekap produksi dari 4 jam menjadi < 15 menit
- 0 kasus penjualan melebihi kuota
- Tingkat pelunasan tepat waktu naik dari 60% menjadi 85%

## Pengguna utama
Admin toko, tim produksi, pelanggan.

## Indikator keberhasilan (setelah 3 bulan)
...

Tujuan yang tidak bisa diukur ("aplikasi yang bagus") tidak bisa dinilai berhasil atau gagal.

3. Dokumen 2: Ruang Lingkup (In Scope dan Out of Scope)

Dokumen ini melindungi Anda dan klien dari pembengkakan fitur.

# Ruang Lingkup

## Termasuk (In Scope) - Rilis 1
- Katalog produk dan periode pre-order
- Checkout, pembayaran DP dan pelunasan via payment gateway
- Dashboard admin: pesanan, produksi, pengiriman
- Notifikasi email

## Tidak termasuk (Out of Scope)
- Aplikasi mobile native
- Integrasi akuntansi
- Multi-bahasa (hanya Indonesia)
- Program loyalti

## Asumsi
- Klien menyediakan akun payment gateway dan konten produk
- Hosting: VPS Ubuntu milik klien

## Ketergantungan
- Persetujuan desain oleh klien maks. 3 hari kerja setelah dikirim

## Prosedur perubahan
Permintaan di luar daftar ini dicatat sebagai *change request*, dinilai dampaknya
(waktu dan biaya), dan baru dikerjakan setelah disetujui tertulis.

4. Dokumen 3: Peran Pengguna dan User Story

Format ringkas:

Sebagai <peran>, saya ingin <tujuan>, agar <manfaat>.

Tambahkan kriteria penerimaan yang bisa diuji:

### US-07: Pelanggan membayar DP
Sebagai pelanggan, saya ingin membayar DP setelah checkout, agar pesanan saya terkunci.

**Kriteria penerimaan**
- ☐ Setelah checkout, saya melihat jumlah DP dan batas waktu pembayarannya
- ☐ Setelah pembayaran sukses, status berubah menjadi "DP Dibayar" dalam < 1 menit
- ☐ Jika lewat batas waktu, pesanan dibatalkan dan kuota dikembalikan
- ☐ Saya menerima email konfirmasi

**Prioritas:** Must

Gunakan prioritas MoSCoW (Must, Should, Could, Won't) agar jelas apa yang masuk rilis pertama.

5. Dokumen 4: Alur Proses

Gambarkan alur bisnis utama dengan diagram. Contoh memakai Mermaid (tampil otomatis di GitHub):

```mermaid
flowchart LR
    A[Pelanggan checkout] --> B{Kuota cukup?}
    B -- Tidak --> X[Tolak pesanan]
    B -- Ya --> C[Buat pesanan & tagihan DP]
    C --> D{DP dibayar < 24 jam?}
    D -- Tidak --> E[Batalkan & kembalikan kuota]
    D -- Ya --> F[Produksi]
    F --> G[Tagih pelunasan]
    G --> H{Lunas?}
    H -- Ya --> I[Kirim & input resi]
    H -- Tidak --> J[Pengingat / batalkan]
```

Definisikan juga status dan transisinya (misalnya status pesanan), karena ini menentukan desain database dan kode.

6. Dokumen 5: Wireframe dan Daftar Halaman

Sebelum menulis Blade, sepakati tampilan kasar. Wireframe boleh sketsa tangan, Figma, atau bahkan tabel:

Halaman

Pengguna

Elemen utama

Catatan

Beranda

Publik

Daftar produk PO aktif, hitung mundur penutupan

Detail produk

Publik

Foto, harga, sisa kuota, tombol Pesan

Kuota realtime

Checkout

Pelanggan

Alamat, ringkasan, DP

Validasi stok

Pesanan saya

Pelanggan

Daftar, status, tombol bayar

Dashboard

Admin

Ringkasan, grafik, tabel pesanan

DataTables

Rekap produksi

Admin

Total unit per varian

Ekspor Excel

Minta klien menyetujui wireframe secara tertulis (cukup balasan email) sebelum desain visual penuh dikerjakan.

7. Dokumen 6: ERD dan Kamus Data

Rancang database sebelum membuat migrasi. Contoh dengan Mermaid:

```mermaid
erDiagram
    USERS ||--o{ ORDERS : membuat
    PRODUCTS ||--o{ ORDER_ITEMS : dipesan
    ORDERS ||--|{ ORDER_ITEMS : berisi
    ORDERS ||--o{ PAYMENTS : dibayar_dengan

    USERS {
        bigint id PK
        string name
        string email UK
    }
    PRODUCTS {
        bigint id PK
        string name
        string sku UK
        bigint price
        int stock
    }
    ORDERS {
        bigint id PK
        bigint user_id FK
        string number UK
        string status
        bigint total
    }
    ORDER_ITEMS {
        bigint id PK
        bigint order_id FK
        bigint product_id FK
        int quantity
        bigint unit_price
    }
    PAYMENTS {
        bigint id PK
        bigint order_id FK
        string type
        bigint amount
        string status
    }
```

Tambahkan kamus data untuk kolom penting:

Tabel.kolom

Tipe

Aturan

orders.status

string (enum)

awaiting_dp, dp_paid, in_production, ..., cancelled

orders.total

unsignedBigInteger

Rupiah, bilangan bulat, tanpa desimal

products.sku

string(50)

Unik, huruf besar

payments.reference

string, nullable

Unik, ID transaksi gateway

Pertanyaan yang harus terjawab di tahap ini:

  • Data apa yang tidak boleh dihapus (gunakan soft delete atau arsip)?

  • Data apa yang harus diaudit (siapa mengubah apa, kapan)?

  • Berapa perkiraan volume data dalam 1 tahun?

  • Apakah ada data pribadi yang diatur regulasi (UU PDP)? Bagaimana retensinya?

8. Dokumen 7: Matriks Hak Akses

Tentukan siapa boleh apa sebelum membuat middleware dan policy.

Fitur

Publik

Pelanggan

Staf produksi

Admin

Lihat katalog

✔

✔

✔

✔

Checkout

✔

✔

Lihat pesanan sendiri

✔

Lihat semua pesanan

✔ (baca)

✔

Ubah status produksi

✔

✔

Kelola produk

✔

Kelola pengguna

✔

Lihat laporan keuangan

✔

Matriks ini langsung menjadi dasar peran dan permission (misalnya dengan Spatie Laravel Permission).

9. Dokumen 8: Spesifikasi API dan Integrasi

Bila aplikasi punya API atau terhubung ke layanan luar:

Integrasi

Tujuan

Yang perlu diketahui

Payment gateway

Pembayaran DP dan pelunasan

Akun sandbox, URL webhook, metode bayar, biaya

Email (SMTP/layanan)

Notifikasi

Batas kirim, domain pengirim (SPF/DKIM)

Kurir / ongkir

Biaya dan resi

API key, batas panggilan

WhatsApp / SMS

Pengingat

Kebijakan template pesan, biaya

Penyimpanan file

Foto produk

S3 atau lokal, ukuran maksimum

Untuk API yang Anda sediakan, tulis kontrak awal dalam OpenAPI:

openapi: 3.0.3
info:
  title: API Toko
  version: 1.0.0
paths:
  /api/v1/products:
    get:
      summary: Daftar produk aktif
      parameters:
        - in: query
          name: page
          schema: { type: integer, default: 1 }
      responses:
        '200':
          description: Berhasil

10. Dokumen 9: Kebutuhan Non-Fungsional

Bagian yang paling sering dilewatkan dan paling mahal bila terlambat.

Kategori

Pertanyaan

Contoh target

Keamanan

Data apa yang sensitif? Siapa yang mengakses?

HTTPS wajib, password di-hash, otorisasi per peran, validasi semua input, log audit

Performa

Berapa pengguna bersamaan? Waktu respons?

Halaman utama < 2 detik pada 200 pengguna bersamaan

Ketersediaan

Berapa downtime yang ditoleransi?

99% per bulan, jendela maintenance malam hari

Backup

Seberapa sering? Berapa lama disimpan?

Harian, simpan 14 hari, uji pemulihan tiap kuartal

Skalabilitas

Pertumbuhan 1 tahun?

3x pengguna tanpa perubahan arsitektur

Kompatibilitas

Browser dan perangkat?

2 versi terbaru browser utama, mobile-first

Aksesibilitas

Standar?

Kontras dan label form dasar

Kepatuhan

Aturan hukum terkait?

UU Perlindungan Data Pribadi, kebijakan privasi

Pemantauan

Bagaimana tahu ada masalah?

Log error terpusat, uptime monitor, alert

11. Dokumen 10: Rencana Teknis dan Lingkungan

Putuskan dan catat keputusan teknis sebelum proyek berjalan.

Keputusan

Opsi

Pilihan kita

Alasan

Versi Laravel

12 / 13

13.x

Dukungan terpanjang, PHP 8.3 tersedia

Versi PHP

8.3 / 8.4

8.3

Sesuai hosting klien

Database

MySQL / MariaDB / PostgreSQL

MySQL 8.x

Sesuai hosting

Antarmuka

Blade+Alpine / Livewire / Inertia

Blade + Alpine

Tim sudah terbiasa

CSS

Tailwind / Bootstrap

Bootstrap 5

Konsisten dengan panel admin

Autentikasi

Bawaan / Fortify / starter kit / SSO

Starter kit

Cepat, teruji

Otorisasi

Spatie Permission / Gate sederhana

Spatie

Banyak peran

Queue

database / Redis

database (awal)

Volume kecil

Cache dan session

database / Redis

database (awal)

Cukup untuk awal

Penyimpanan file

lokal / S3

lokal + symlink

Volume kecil

Hosting

VPS / shared / cloud

VPS Ubuntu

Kontrol penuh

CI/CD

GitHub Actions / manual

GitHub Actions

Otomatis test

Daftar lingkungan:

Lingkungan

Tujuan

Data

Akses

Lokal

Pengembangan

Dummy (seeder/factory)

Developer

Staging

Uji penerimaan klien

Dummy, mirip production

Tim + klien

Production

Pengguna nyata

Asli

Terbatas, terkontrol

Catat keputusan penting sebagai ADR (Architecture Decision Record) singkat:

# ADR 0001: Memilih Blade + Alpine daripada Livewire

- **Status:** Diterima
- **Tanggal:** 2026-10-19
- **Konteks:** Tim kecil, 2 developer, belum berpengalaman dengan Livewire. Interaksi
  yang dibutuhkan sederhana (modal, tab, filter).
- **Keputusan:** Gunakan Blade dengan Alpine.js.
- **Konsekuensi:** Pengembangan awal cepat. Bila kebutuhan interaktif membesar, evaluasi
  ulang dan pertimbangkan Livewire untuk modul tertentu.

Konvensi tim yang perlu disepakati:

  • Gaya kode (Laravel Pint), analisis statis (Larastan).

  • Strategi cabang dan format commit (lihat artikel Git).

  • Penamaan: tabel jamak (products), model tunggal (Product), route bernama.

  • Struktur folder dan lapisan (controller tipis, service untuk logika bisnis).

12. Dokumen 11: Rencana Pengujian dan Definition of Done

Kapan sebuah fitur dianggap selesai? Sepakati di awal.

# Definition of Done (DoD)

Sebuah fitur dianggap selesai bila:
- ☐ Memenuhi seluruh kriteria penerimaan user story
- ☐ Test otomatis (Feature) untuk jalur utama dan kasus gagal lulus
- ☐ Validasi input dan otorisasi sudah ada
- ☐ Tidak ada N+1 query (dicek lewat strict mode / Debugbar)
- ☐ Gaya kode lulus (`pint --test`) dan analisis statis lulus
- ☐ PR sudah ditinjau dan disetujui minimal satu orang
- ☐ Migrasi aman dijalankan dua arah, dan kompatibel mundur
- ☐ Dokumentasi/README/`.env.example` diperbarui
- ☐ Sudah diuji di staging dan disetujui klien

Jenis pengujian:

Jenis

Alat

Cakupan

Unit

PHPUnit / Pest

Service dan logika murni

Feature

php artisan test

Alur HTTP dan database

Penerimaan (UAT)

Staging + checklist klien

Skenario bisnis nyata

Keamanan

OWASP ZAP, composer audit

Kerentanan umum

Beban

wrk, k6

Halaman kritis

13. Dokumen 12: Jadwal, Risiko, dan Anggaran

Jadwal berbasis tonggak (milestone):

Tonggak

Isi

Tenggat

M1

Dokumen disetujui, wireframe disetujui

Minggu 1

M2

Fondasi: autentikasi, peran, katalog

Minggu 3

M3

Checkout dan pembayaran

Minggu 5

M4

Dashboard admin dan laporan

Minggu 7

M5

UAT di staging, perbaikan

Minggu 8

M6

Rilis dan serah terima

Minggu 9

Tambahkan buffer (umumnya 15 sampai 25%) karena estimasi hampir selalu meleset.

Daftar risiko:

Risiko

Kemungkinan

Dampak

Mitigasi

Akun payment gateway terlambat disetujui

Sedang

Tinggi

Mulai pengajuan di minggu 1, pakai sandbox

Perubahan kebutuhan di tengah jalan

Tinggi

Sedang

Prosedur change request

Developer kunci berhalangan

Rendah

Tinggi

Dokumentasi, review silang

Lonjakan trafik saat PO dibuka

Sedang

Tinggi

Uji beban, queue, cache

Kebocoran data

Rendah

Sangat tinggi

Otorisasi, audit, backup, HTTPS

14. Dokumen 13: Kontrak dan Serah Terima

Untuk proyek dengan klien, pastikan tertulis:

Hal

Isi minimal

Lingkup dan deliverables

Mengacu pada dokumen ruang lingkup

Jadwal dan pembayaran

Tonggak, termin, denda atau bonus bila ada

Hak cipta dan lisensi

Kepemilikan kode, lisensi pustaka pihak ketiga

Kerahasiaan

Penanganan data dan akses

Garansi dan pemeliharaan

Masa garansi bug, biaya dukungan sesudahnya

Serah terima

Source code, dokumentasi API, panduan instalasi, akses repository

Prosedur perubahan

Cara menangani permintaan di luar lingkup

15. Checklist Kesiapan Teknis Laravel (Sebelum composer create-project)

Keputusan dan akses

  • ☐ Versi Laravel dan PHP diputuskan, dan versi PHP production mendukungnya

  • ☐ Repository dibuat (privat), aturan cabang dan proteksi main ditetapkan

  • ☐ Akses server, domain, dan DNS tersedia atau jadwalnya jelas

  • ☐ Akun layanan pihak ketiga (payment, email, penyimpanan, peta) tersedia, sandbox siap

  • ☐ Rencana backup dan pemulihan ditetapkan

Lingkungan dan alat

  • ☐ Lingkungan lokal seragam (Laragon/Docker) dan versi PHP, Node.js, database dicatat di README

  • ☐ .env.example lengkap, tanpa rahasia

  • ☐ Pint, Larastan, dan test dikonfigurasi, CI berjalan sejak commit pertama

  • ☐ Strategi data uji (factory dan seeder) disepakati

Desain

  • ☐ ERD disetujui, aturan uang (integer rupiah) dan zona waktu ditetapkan

  • ☐ Matriks hak akses disetujui

  • ☐ Wireframe disetujui klien

  • ☐ Daftar status dan alur proses terdefinisi

Keamanan dan kepatuhan

  • ☐ Data pribadi yang diproses diidentifikasi, kebijakan privasi disiapkan

  • ☐ Rencana penanganan password, session, upload file, dan webhook

  • ☐ Rencana pengujian keamanan (audit dependensi, pemindaian)

16. Menghubungkan Dokumen ke Kode: Scaffolding Awal

Setelah dokumen disepakati, kerangka awal bisa dibuat langsung dari ERD dan user story:

composer create-project laravel/laravel toko
cd toko
git init && git add . && git commit -m "chore: inisialisasi proyek"

# dari ERD: model + migrasi + factory
php artisan make:model Product -mf
php artisan make:model Order -mf
php artisan make:model OrderItem -m
php artisan make:model Payment -m

# dari matriks akses: policy
php artisan make:policy OrderPolicy --model=Order

# dari alur status: enum
php artisan make:enum Enums/OrderStatus

# dari user story: test (dengan kriteria penerimaan sebagai nama test)
php artisan make:test CheckoutTest

Setiap kriteria penerimaan pada user story menjadi satu test. Dengan begitu dokumen dan kode tetap sejalan.

Troubleshooting

Masalah

Penyebab umum

Solusi

Klien terus menambah fitur ("sekalian ya")

Ruang lingkup tidak tertulis atau tak disepakati

Rujuk dokumen ruang lingkup, proses lewat change request dengan estimasi waktu dan biaya

Klien tidak punya waktu menjelaskan kebutuhan

Tidak ada jadwal wawancara

Jadwalkan sesi singkat berfokus, kirim draf tertulis untuk dikoreksi

Dokumen tidak pernah dibaca

Terlalu panjang atau tidak relevan

Ringkas (satu halaman per dokumen), gunakan diagram dan tabel

Dokumen cepat usang

Disimpan di tempat terpisah dari kode

Simpan di docs/ dalam repository, perbarui lewat PR yang sama dengan kodenya

Skema database dirombak berkali-kali

ERD tidak ditinjau sebelum migrasi

Tinjau ERD bersama sebelum make:migration; lakukan walkthrough skenario utama

Estimasi selalu meleset

Tidak ada buffer, pekerjaan tersembunyi (deploy, UAT, revisi)

Pecah tugas kecil, tambahkan buffer 15 sampai 25%, masukkan UAT dan deploy dalam jadwal

Hak akses ternyata tidak sesuai kebutuhan di akhir

Matriks akses tidak dibuat

Buat matriks sejak awal, ujikan tiap peran

Fitur "selesai" tetapi klien menolak

DoD dan kriteria penerimaan tidak ada

Tulis kriteria penerimaan terukur, demo rutin di staging

Hosting tidak mendukung versi PHP yang dipilih

Tidak dicek sebelum memilih versi Laravel

Pastikan versi PHP production sejak awal; Laravel 13 butuh PHP 8.3+

Integrasi pihak ketiga tertunda

Akun/persetujuan baru diurus belakangan

Ajukan di minggu pertama, kembangkan dengan sandbox

Tidak ada yang tahu cara menjalankan proyek

README tidak ada

Wajibkan README, .env.example, dan skrip setup; uji di mesin bersih

Dokumen tidak disetujui secara tertulis

Persetujuan hanya lisan

Konfirmasi lewat email atau tanda tangan, simpan arsipnya

Best Practices

Keamanan

  • Identifikasi data sensitif dan aturan aksesnya sebelum menulis kode, bukan sesudah.

  • Tentukan matriks hak akses tertulis dan jadikan dasar test otorisasi.

  • Rencanakan penanganan rahasia (.env, kunci API), backup, dan pemulihan sejak awal.

  • Cantumkan kebutuhan keamanan di non-fungsional, dan jadwalkan audit sebelum rilis.

  • Pastikan kepatuhan terhadap regulasi perlindungan data pribadi yang berlaku untuk pengguna Anda.

Performa

  • Tulis target performa yang terukur (waktu respons, pengguna bersamaan) dan uji terhadapnya.

  • Pikirkan skenario lonjakan (peluncuran, promo, pembukaan PO) dalam rencana teknis.

  • Rancang index dan volume data di ERD, dan hindari N+1 sebagai bagian dari DoD.

Maintainability

  • Dokumentasi secukupnya dan tinggal bersama kode di docs/, diperbarui lewat PR.

  • Catat keputusan penting sebagai ADR, agar anggota baru memahami alasan di balik pilihan teknis.

  • Sepakati konvensi (gaya kode, cabang, commit, struktur folder) di awal dan otomatiskan lewat CI.

  • Jadikan kriteria penerimaan sebagai test otomatis.

  • Tinjau dokumen di setiap tonggak dan perbarui bila kebutuhan berubah secara resmi.

  • Siapkan dokumentasi serah terima (API, instalasi, changelog) sejak pertengahan proyek, bukan di hari terakhir.

Related Articles

Last Tested

Catatan jujur: artikel ini bersifat panduan proses, bukan tutorial yang bisa "dijalankan". Templat dan contoh perintah disusun dari praktik umum dan dokumentasi resmi Laravel. Contoh Mermaid dan OpenAPI belum divalidasi oleh penulis. Uji render Mermaid di GitHub dan validasi OpenAPI di editor Anda.

Komponen

Versi acuan penulisan

Versi saat Anda menguji

PHP

8.3.x

Laravel

13.x (kompatibel dengan 12.x)

Mermaid

Dirender oleh GitHub / editor Markdown

OpenAPI

3.0.3

Tanggal uji

Bagikan artikel:

Artikel lainnya