Dokumentasi Engineering — Migrasi ERP Lucky Jaya Group¶
Docs-as-code untuk onboarding, operasi, dan pemeliharaan berbantuan AI.
Bahasa Indonesia untuk istilah domain; istilah teknis standar (CDC, OLAP, JWT) tetap Inggris bila lazim.
Monitoring proyek¶
| Halaman | Untuk |
|---|---|
| monitoring/dashboard.html | Dashboard interaktif — grafik Chart.js, tabel sort/filter (auto) |
| project-dashboard.md | Ringkasan markdown (auto + catatan strategis) |
| project-todo-global.md | TODO P0, gate cutover, indeks */TODO.md |
npm run progress # parse TODO*.md → perbarui dashboard
npm run docs:serve # portal MkDocs (tab Monitoring)
Setup GitHub Pages + Hermes Telegram: monitoring/SETUP-MONITORING.md.
CI/CD & Automation¶
| Workflow | Trigger | Output |
|---|---|---|
| Track TODO Progress | Push TODO files | Artifact .progress.json |
| Docs & Dashboard Pages | Push main/dev |
GitHub Pages deploy |
| Hermes Cron (lokal) | Senin 08:00 UTC | Telegram notification |
Dokumentasi lengkap: references/github-actions-ci-cd.md
Mulai di sini¶
| Peran | Jalur baca |
|---|---|
| Arsitek / lead | architecture/architecture-overview.md → migration/migration-status.md → flows/event-flow.md |
| Backend | backend/README.md → api/README.md → ../backend/docs/00-ARSITEKTUR-BACKEND.md |
| Database / DBA | postgresql/README.md → ../database/docs/00-ARSITEKTUR-SCHEMA-PER-TENANT.md |
| Flutter | flutter/README.md → ../frontend/flutter/erp/AUTH.md |
| DevOps / SRE | deployment/deployment-overview.md → runbooks/README.md → monitoring/monitoring-flow.md |
| Onboarding umum | ../ONBOARDING-TEAM.md → 09-SEJARAH-DAN-FILOSOFI-SISTEM.md |
Aturan agent & non-negotiable: ../AGENTS.md. Indeks TODO lintas workstream: ../TODO.md.
Peta folder dokumentasi¶
docs/
├── architecture/ # Batas sistem, tanggung jawab, dependensi
├── migration/ # Legacy → modern, status, risiko
├── backend/ # NestJS, modul, ownership
├── flutter/ # Klien mobile, auth, API
├── monitoring/ # Observability & dashboard operasional
├── kafka/ # Topik, consumer, replay
├── clickhouse/ # OLAP, pola query, DDL sync
├── postgresql/ # Schema, trigger-first, tenant
├── api/ # Kontrak REST, OpenAPI
├── flows/ # Alur data & event end-to-end
├── infrastructure/ # Docker, jaringan, komponen
├── deployment/ # Rilis, env, checklist
├── runbooks/ # Indeks prosedur operasional
├── troubleshooting/ # Diagnosis & placeholder area risiko
├── glossary/ # Istilah domain & teknis
├── decisions/ # ADR ringkas & keputusan tetap
└── references/ # Indeks sumber kebenaran di repo (termasuk CI/CD)
Dokumen fondasi¶
| Dokumen | Isi |
|---|---|
| project-dashboard.md | Dashboard monitoring 1 halaman |
| project-todo-global.md | TODO global agregasi |
| architecture/architecture-overview.md | Gambaran sistem & batas layanan |
| architecture/service-dependencies.md | Matriks dependensi & ownership |
| flows/event-flow.md | PG → Debezium → Kafka → ClickHouse |
| migration/migration-status.md | Status fase & tenant |
| migration/legacy-to-modern-mapping.md | Pemetaan modul legacy → baru |
| glossary/glossary.md | Glosarium terpadu |
| glossary/naming-conventions.md | Konvensi penamaan |
| kafka/kafka-topics.md | Konvensi topik & consumer |
| clickhouse/clickhouse-patterns.md | Engine, MV, DDL sync |
| monitoring/monitoring-flow.md | CDC monitor, lag, health |
| deployment/deployment-overview.md | Komponen deploy & port |
Ringkasan reorganisasi: DOCUMENTATION-IMPROVEMENT-SUMMARY.md.
Seri dokumen arsitektur asli (tetap kanonik)¶
Dokumen bernomor 00–15 tidak dipindahkan agar referensi Git/RAG tetap valid. Mereka tetap sumber kebenaran untuk keputusan bisnis & desain awal.
| # | Dokumen | Kategori baru |
|---|---|---|
| 00 | Ringkasan Eksekutif | architecture, migration |
| 01 | Audit Sistem Lama | migration |
| 02 | Kamus Data & Glosarium | glossary (ringkas → glossary/glossary.md) |
| 03 | Desain Database Baru | postgresql |
| 04 | Arsitektur Multi-Tenant | architecture |
| 05 | Logika Bisnis FIFO/Stok/Jurnal | postgresql |
| 06 | Strategi Migrasi Big-Bang | migration |
| 07 | Standar & Konvensi Tim | glossary |
| 08 | Konsolidasi Identitas & Penomoran | architecture |
| 09 | Sejarah & Filosofi | architecture (wajib hari ke-1) |
| 10 | Klien, Auth & Realtime | flutter, api |
| 11 | Navigasi Mobile | flutter, api |
| 14 | Kas, Biaya & Pajak | postgresql |
| 15 | AI Orchestration Cloudflare | architecture |
Sumber kebenaran per workstream (di luar docs/)¶
| Workstream | Lokasi kanonik |
|---|---|
| PostgreSQL & migrasi | database/ — docs/, migrations/, RUNBOOK.md |
| CDC & ClickHouse | database/cdc/ |
| ETL legacy MariaDB | database/etl/ |
| Backend API | backend/ — docs/, RUNBOOK.md, openapi.json |
| Flutter | frontend/flutter/ |
| Monitor operasional | frontend/web/migrasi-ui/ |
| Portal migrasi tenant | frontend/web/migrasi-ui/portal-migrasi-tenant/ |
Indeks otomatis workspace: ../index.md.
Prinsip dokumentasi¶
- Tidak menduplikasi — ringkasan di
docs/mengarah ke sumber kanonik di folder implementasi. - Tidak mengarang logika bisnis — rujuk trigger/ETL/kode; tandai
TODObila belum terdokumentasi. - Asumsi eksplisit — gunakan blok Asumsi / belum diverifikasi di dokumen placeholder.
- Siap MkDocs/Docusaurus — path relatif, front matter opsional, diagram Mermaid.
Terakhir diperbarui: 2026-05-25 — reorganisasi struktur docs/.