Skip to content

frandika06/docs-ai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 

Repository files navigation

docs-ai — AI Vibe Coding Documentation Template

Version: 1.4.0 — Single source: ai-rules/. All other folders are AI-generated output. Repository: github.com/frandika06/docs-ai


Apa Ini?

Template dokumentasi untuk vibe coding — development berbantuan AI. Satu folder ai-rules/ berisi semua kontrak kerja, aturan, dan template. AI membaca template dari ai-rules/, lalu membuat folder output (planning/, dev-docs/, dll) di root project.

Prinsip: ai-rules/ = IMMUTABLE (AI hanya baca). Folder lain = OUTPUT (AI yang buat).


Quick Start — 1 Command

# Copy ai-rules/ ke project baru
cp -r ai-rules/ /path/to/new-project/

# Prompt AI (pilih salah satu):
# Mode A (Brief Manual):
#   "baca PROJECT_BRIEF.md yang sudah saya isi, lalu setup planning/ dan dev-docs/"
# Mode B (Interaktif):
#   "saya mau bikin aplikasi [deskripsi]. Setup project ini untuk vibe coding."

Struktur

docs-ai/
├── README.md              ← File ini
└── ai-rules/              ← SATU-SATUNYA SOURCE — copy ini ke project baru
    ├── AGENTS.md          ← Root AI contract
    ├── README.md          ← Mapping template → output
    ├── planning-templates/       ← AI baca → buat planning/
    ├── dev-docs-ai-templates/    ← AI baca → buat dev-docs/ai/
    ├── architecture-templates/   ← AI baca → buat dev-docs/architecture/
    ├── modules-template/         ← AI baca → buat dev-docs/modules/
    ├── revamp-templates/         ← AI baca → buat revamp/
    ├── prod-docs-templates/      ← AI baca → buat prod-docs/
    ├── reports-templates/        ← AI baca → buat reports/
    ├── coding-standards/         ← Aturan coding (11 section)
    ├── security/                 ← Security standards (17 Part)
    ├── operations/               ← Ops templates
    ├── deployment/               ← Deploy rules/templates
    ├── migration/               ← Docs migration guides
    └── ... (postman, testing, troubleshooting, dll)

6 Skenario

Decision Matrix

# Skenario Ciri Folder Output Dibuat AI Prompt Sample
1 New Belum ada kode planning/, dev-docs/ Lihat di bawah
2 Revamp 1:1 1 old app → 1 new app revamp/, planning/, dev-docs/ Lihat di bawah
3 Merger N:1 N apps → 1 app revamp/, planning/, dev-docs/ Lihat di bawah
4 Adopsi Existing app non-vibe dev-docs/ Lihat di bawah
5 Maintenance Production app reports/ Lihat di bawah
6 Docs Migration Existing unstructured docs → template planning/, dev-docs/, prod-docs/, backup/old-docs/ Lihat di bawah

Sample AI Prompts

Skenario 1: New Project (Belum Ada Kode)

Mode A — User isi brief dulu:

Saya sudah mengisi planning/PROJECT_BRIEF.md. Baca brief tersebut, lalu:
1. Isi semua file planning/ dari template di ai-rules/planning-templates/
2. Isi semua file dev-docs/ai/ dari template di ai-rules/dev-docs-ai-templates/
3. Isi file dev-docs/architecture/ dari template di ai-rules/architecture-templates/
4. Setup struktur folder kode (apps/ untuk monolith, atau backend/+frontend/ untuk fullstack)
5. Init git di folder kode
6. Mulai coding sesuai planning

Mode B — AI bertanya interaktif (tidak ada brief):

Saya mau bikin aplikasi [deskripsi singkat, misal: "sistem HRIS untuk perusahaan 500 karyawan"].
Setup project ini untuk vibe coding. Baca AGENTS.md dulu, lalu tanya kebutuhan project secara interaktif.

Mode C — Langsung dengan detail:

Saya mau bikin aplikasi inventory management.

Framework: Laravel + Livewire (monolith)
Database: PostgreSQL
Cache: Redis
Queue: Redis
UI: Stisla template (sudah ada di ai-rules/reference/template/)

Baca AGENTS.md, lalu buat PROJECT_BRIEF.md, isi planning/, setup kode (apps/ untuk monolith, atau backend/ + frontend/ untuk fullstack), lalu mulai coding.

Skenario 2: Revamp 1:1 (Rewrite 1 Aplikasi)

Saya punya aplikasi lama di /path/to/old-app. Aplikasi ini adalah [deskripsi].
Saya mau rewrite total ke [stack baru: monolith/fullstack, framework, database].

Baca AGENTS.md, lalu:
1. Audit aplikasi lama → isi revamp/old-system.md dari template ai-rules/revamp-templates/
2. Gap analysis → isi revamp/gap-analysis.md
3. Buat planning/ untuk sistem baru dari template ai-rules/planning-templates/
4. Setup kode baru di apps/ (atau backend/+frontend/)
5. Mulai coding. Old system READ-ONLY — hanya dibaca, tidak diubah.

Skenario 3: Merger N:1 (Gabung Beberapa Aplikasi)

Saya punya [N] aplikasi terpisah:
- App A: /path/to/app-a (sistem kepegawaian, Laravel)
- App B: /path/to/app-b (sistem keuangan, Laravel)
- App C: /path/to/app-c (sistem aset, Laravel)

Saya mau gabung ke 1 aplikasi utama. Target di /path/to/new-project.

Baca AGENTS.md, lalu:
1. Audit semua apps → isi revamp/ dari template ai-rules/revamp-templates/
2. Overlap check — fitur yang tumpang tindih
3. Merger plan — app mana jadi target, mana yang di-drop
4. Buat planning/ + dev-docs/ untuk sistem gabungan
5. Mulai coding

Skenario 4: Adopsi (Existing Non-Vibe Project)

Saya punya aplikasi existing di /path/to/existing-project.
Sebelumnya dikerjakan tanpa AI (vibe coding). Stack: [sebutkan].

Saya mau adopsi project ini ke vibe coding. Copy-kan ai-rules/ ke project tersebut,
lalu baca AGENTS.md dan lakukan onboarding analysis 10-step:
1. Baca seluruh codebase
2-10. Isi semua file dev-docs/ dari template di ai-rules/

Jangan ubah kode dulu — dokumentasikan dulu apa yang ada.

Skenario 5: Maintenance (Project Production)

Project di /path/to/production-project sudah mature dan di production.
Saya mau scheduled maintenance untuk tahun [2026].

Baca AGENTS.md, lalu:
1. Baca ai-rules/deployment/ssh-access.md untuk aturan akses server
2. Set MAINTENANCE_ACTIVE: true
3. Baca KAK maintenance (jika sudah ada) atau buat draft KAK dari template
4. Eksekusi scope satu per satu
5. Laporan per scope di reports/maintenance/
6. Backup production WAJIB sebagai scope pertama

Lingkup: [sebutkan — misal: upgrade Laravel 10→11, security audit, performance tuning]

Skenario 6: Docs Migration (Restrukturisasi Dokumentasi Existing)

Saya punya project existing di /path/to/project yang sudah ada dokumentasi,
tapi belum terstruktur. Dokumentasi ada di folder: [docs/], [wiki/], [README].
Stack: [sebutkan — Laravel monolith / Go + React fullstack]. Project type: [monolith/fullstack].

Saya mau migrasikan dokumentasi existing ke struktur docs-ai.
Copy-kan ai-rules/ ke project tersebut, lalu baca AGENTS.md dan
ai-rules/migration/README.md, lalu:
1. Audit semua dokumentasi existing
2. Backup ke backup/old-docs/
3. Map konten ke folder output sesuai ai-rules/migration/_DOCS_MAPPING_TEMPLATE.md
4. Ekstrak info dari old docs → isi file output (planning/, dev-docs/, prod-docs/)
5. Buat DOCS_MIGRATION_REPORT.md di dev-docs/ai/
6. Update START_HERE.md dengan informasi hasil migrasi
7. Laporkan gaps yang butuh klarifikasi

Setelah migrasi selesai:

Review DOCS_MIGRATION_REPORT.md yang baru dibuat. Jawab pertanyaan di section Gaps & Ambiguities.
Setelah itu, lanjut isi file-file yang masih kosong.

Migrasi dari spesifik format:

Saya punya dokumentasi di [Google Docs / Notion / Confluence / wiki] yang sudah
saya export ke .md di folder /path/to/docs-export/.

Baca ai-rules/migration/README.md, lalu migrasikan semua konten
ke struktur docs-ai.

Production Deploy & Server Setup

Deploy Pertama Kali (Initial Server Setup)

Project sudah siap production. Server di [IP/Host], SSH config name: [config-name].

Baca ai-rules/deployment/git-remote.md dan ai-rules/deployment/ssh-access.md, lalu:
1. SSH ke server
2. Clone repository ke /var/www/[app-name] (pakai deploy key atau token — lihat git-remote.md)
3. Setup .env dari .env.example
4. Install dependencies (composer/npm)
5. Build assets, migrate database
6. Setup supervisor (queue worker), cronjob (scheduler)
7. Setup nginx config + SSL
8. Buat dokumentasi server di prod-docs/ dari template ai-rules/prod-docs-templates/
9. Copy prod-docs/ ke server: scp -r prod-docs/ user@server:/root/docs-ai/
10. Verifikasi: curl https://[domain]/health

Deploy Rutin (CD — Continuous Delivery)

Ada perubahan baru di branch [dev/main]. Deploy ke server production.

Baca ai-rules/deployment/ssh-access.md, lalu:
1. SSH ke server
2. cd /var/www/[app-name] && git pull origin [branch]
3. composer install --no-dev && npm ci && npm run build
4. php artisan migrate --force (jika ada migration baru)
5. php artisan config:cache && php artisan route:cache
6. php artisan queue:restart
7. systemctl reload nginx
8. Verifikasi: curl https://[domain]/health
9. Buat laporan task di reports/task/

Setup Dokumentasi Server (Production Documentation)

Server production [IP/Host] sudah running aplikasi [nama].
Belum ada dokumentasi server. Saya mau buat dokumentasi lengkap untuk AI agent yang akan maintain server ini.

Baca ai-rules/prod-docs-templates/, lalu:
1. Buat folder prod-docs/ di local dari template
2. Isi AGENTS.md dengan informasi server aktual (IP, SSH config, app path)
3. Isi docs/architecture/overview.md — arsitektur server
4. Isi docs/architecture/network-topology.md — network setup
5. Isi docs/tech-stack/[app].md — dokumentasi per komponen (nginx, docker, app, database)
6. Isi docs/operations/deployment.md — proses deploy aktual
7. Isi docs/operations/backup.md — strategi backup
8. Isi docs/operations/monitoring.md — monitoring & alerting
9. Isi docs/operations/security.md — security hardening
10. Copy ke server: scp -r prod-docs/ user@server:/root/docs-ai/

Deploy Multi-Server (Load Balanced)

Aplikasi [nama] di-deploy ke 2 server production:
- Server A: [IP/Host] (web + app)
- Server B: [IP/Host] (web + app)
Load balancer: [IP/Host] (nginx/haproxy)

Shared: database di [IP/Host], redis di [IP/Host], storage di S3.

Baca ai-rules/deployment/ssh-access.md dan ai-rules/prod-docs-templates/, lalu:
1. Setup deploy key di masing-masing server
2. Clone repository ke /var/www/[app-name] di kedua server
3. Pastikan .env konsisten (beda APP_URL, sama DB/REDIS/S3)
4. Setup auto-deploy webhook atau systemd timer di kedua server
5. Setup health check: GET /health → return 200
6. Dokumentasikan di prod-docs/docs/architecture/network-topology.md
7. Dokumentasikan per-server di prod-docs/docs/tech-stack/server-a.md dan server-b.md

Rollback Production

Deploy terakhir ke production menyebabkan error [deskripsi].
Rollback ke versi sebelumnya.

Baca ai-rules/deployment/ssh-access.md, lalu:
1. SSH ke server
2. cd /var/www/[app-name]
3. git log --oneline -20 → cari hash commit yang aman
4. git reset --hard [hash_commit_aman]
5. composer install --no-dev && npm run build (jika aset berubah)
6. php artisan migrate:rollback (jika migration perlu di-rollback)
7. systemctl reload nginx
8. Verifikasi: curl https://[domain]/health
9. Buat laporan incident di reports/task/YYYY-MM-DD-rollback-production.md

Server Maintenance & Audit

Server production [IP/Host] perlu maintenance rutin bulanan.

Baca ai-rules/deployment/ssh-access.md (set MAINTENANCE_ACTIVE: true), lalu:
1. Backup database + storage → lihat ai-rules/deployment/maintenance/backup-procedure.md
2. Cek disk usage: df -h
3. Cek service status: systemctl status nginx php*-fpm supervisor redis
4. Cek log errors: tail -100 /var/log/nginx/error.log
5. Rotate logs jika perlu
6. Cek SSL expiry: openssl s_client -connect [domain]:443 -servername [domain]
7. Update dependencies security patch: composer update && npm update
8. Security audit: lihat ai-rules/security/part-i-security-pre-merge-checklist.md
9. Restart services jika perlu
10. Buat laporan di reports/maintenance/[tahun]/Laporan/

Skenario Tambahan (Referensi)

11. Emergency Hotfix (Production Down)

Production down — aplikasi [nama] error [deskripsi error].
Bypass proses normal. Baca ai-rules/security/ dan ai-rules/deployment/ssh-access.md,
lalu:
1. SSH ke server, cek logs
2. Identifikasi root cause
3. Fix di local, test minimal
4. Deploy segera
5. Laporan incident setelah stabil

12. API-First (Backend Service untuk Multi Client)

Saya mau bikin backend API untuk [deskripsi service].
Akan dikonsumsi oleh mobile app (Flutter) dan web app (Vue 3).

Stack: Go Fiber + PostgreSQL + Redis. Fullstack (backend/ + frontend/).
Baca AGENTS.md, setup dengan fokus di API contract dan Postman documentation.
Gunakan template dari ai-rules/postman/ untuk dokumentasi API.

13. Plugin/Extension (Platform Existing)

Saya mau bikin plugin [WordPress / Shopify / Moodle / lain] untuk [deskripsi fitur].
Project diletakkan di [lokasi]. Platform SDK/docs di [url].

Baca AGENTS.md. Karena ini plugin untuk platform existing:
- Tidak bisa pilih framework bebas — ikuti konvensi platform
- Tidak perlu planning/architecture/database — platform sudah sediakan
- Fokus di dev-docs/modules/ dan testing/

14. Microservice Extraction (Monolith → N Services)

Dari monolith di apps/, saya mau extract modul [nama_modul] jadi service terpisah.
Pakai pendekatan strangler fig — extract bertahap.

Baca AGENTS.md, lalu:
1. Analisis domain boundaries dari modul yang akan di-extract
2. Buat revamp/ untuk dokumentasi strategi extraction (pakai template dari ai-rules/revamp-templates/)
3. Definisikan API contract antar service
4. Buat repo baru untuk service yang di-extract
5. Migration data — database mana milik service mana

15. Proof of Concept → Production (MVP Hardening)

Aplikasi [nama] sudah jalan sebagai POC/MVP di [lokasi]. Kode masih kotor, belum ada tests,
security belum diterapkan.

Baca AGENTS.md. Lakukan hardening:
1. Audit existing code → isi dev-docs/ai/TECHNICAL_DEBT.md
2. Terapkan security standards dari ai-rules/security/
3. Refactor sesuai coding standards dari ai-rules/coding-standards/
4. Tambah tests
5. Buat dev-docs/architecture/ jika belum ada
6. Production readiness review

Fitur Utama Template

Untuk AI Agent

  • Onboarding cepatAGENTS.md sebagai titik masuk, README.md sebagai panduan struktur
  • Template immutable — AI baca template di ai-rules/, output di folder terpisah
  • Split-per-concern — file dokumentasi dipecah per aspek (CURRENT_STATE terpisah dari MODULE_MAP)
  • Anti-monster rule — arsip otomatis untuk file tumbuh tak terbatas
  • Laporan wajib — setiap push/merge buat laporan task dengan snapshot
  • Security enforcement — Part A-Q (17 files) di ai-rules/security/
  • UI/UX template rules — WAJIB gunakan template HTML atau framework established
  • Version recommendation — AI rekomendasikan versi rilis berdasarkan CHANGELOG

Untuk Human Developer

  • 1 command copycp -r ai-rules/ /path/to/project/
  • Template tidak pernah rusak — AI tidak bisa overwrite template di ai-rules/
  • Visibility — lihat semua kerja AI via reports/task/
  • Rollback safetyCOMMIT_LOG.md dengan hash tiap commit
  • Git-based deployment — menggantikan SFTP drag-drop
  • Production readiness — bridge document + prod-docs untuk handover

Prinsip Desain

  1. AI membaca seminimal mungkin — split-per-concern + anti-monster rule
  2. AI tidak mengubah kontrakai-rules/ adalah IMMUTABLE, AI hanya baca
  3. Human tetap in control — semua keputusan besar tetap minta persetujuan
  4. Dokumentasi adalah side-effect — AI otomatis update docs setiap selesai task
  5. Stack-agnostic — placeholder {cd apps|cd backend} untuk monolith dan fullstack
  6. Security by default — AI WAJIB terapkan security standards tanpa diminta
  7. Bridge document — mekanisme transfer informasi dari development ke production
  8. Operations-first — setiap fitur yang butuh deployment WAJIB punya dokumentasi ops
  9. Credential boundary — credential di folder kode (apps/, backend/, frontend/) HANYA di .env. DILARANG di file .md yang masuk git. Credential BOLEH di dokumentasi folder root (prod-docs/, dev-docs/) karena DI LUAR git repo.

Changelog

  • v1.4.0 — Security overhaul: credential boundary rule (Part A rule #11), .md credential grep di pre-merge checklist, operations templates menggunakan .env references bukan inline credentials, INSIDE/OUTSIDE git location labels di templates, resolve ssh-access.md IP contradiction, FINAL_SYSTEM_HANDOVER content restriction, NoSQL Injection + ReDoS + LDAP Injection + SRI + Cookie Security di Part B/D, Postman environment credential fix. Tambah Skenario 6: Docs Migration (audit + mapping + migrasi dokumentasi unstructured ke template structure)
  • v1.3.0 — Restruktur total: ai-rules/ sebagai satu-satunya source immutable. Semua folder output dibuat AI dari template. Tambah sample prompts untuk 5 skenario + 5 skenario referensi.
  • v1.2.0 — Bridge document, security enforcement (Part A-Q), operations templates, UI/UX rules, Postman templates
  • v1.1.0 — Production server documentation (prod-docs/), operations documentation system
  • v1.0.0 — Initial release dengan 5 skenario (New, Revamp, Merger, Adopsi, Maintenance)

About

Dokumentasi untuk vibe coding

Resources

Stars

105 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors