6.8 KiB
Workspace Context
Purpose
Dokumen ini adalah root context untuk seluruh workspace.
Workspace ini memiliki satu atau lebih repository.
Jangan melakukan analisis seluruh workspace sekaligus.
Selalu identifikasi repository yang relevan, kemudian baca docs/context-index.md pada repository tersebut sebagai sumber informasi utama.
Rules
- Selalu baca
Workspace-Context.mdterlebih dahulu. - Tentukan repository yang relevan.
- Baca hanya
docs/context-index.mdpada repository tersebut. - Ikuti seluruh referensi dokumentasi yang terdapat pada
docs/context-index.md. - Jangan membaca atau memodifikasi repository lain kecuali benar-benar dibutuhkan.
- Jika pekerjaan melibatkan lebih dari satu repository, baca
docs/context-index.mdmasing-masing repository yang terkait. - Jangan membuat asumsi mengenai arsitektur, API, database, server, maupun implementasi tanpa membaca dokumentasi repository terkait.
Repository Registry
Workspace ini berisi beberapa repository. Jangan analisis semuanya sekaligus — pilih yang relevan.
| Repository | Path lokal | Git remote | Entry point | Peran |
|---|---|---|---|---|
| LDAPWeb (monorepo) | D:\Project\app on git\ |
git.gisportal.id/rbsetiawan/LDAPWeb |
Workspace-Context.md |
Root workspace, dokumentasi lintas-repo |
| GeoNetAgent | GeoNetAgent/ |
(dalam monorepo LDAPWeb) | GeoNetAgent/docs/context-index.md |
Agent Windows, collector FastAPI, infra asset |
| server-connection | server-connection/ |
(dalam monorepo LDAPWeb) | server-connection/docs/context-index.md |
Backend Laravel: geonet-console, databaselist, sqlservercheck |
| mysupperapps_FE_PWA | mysupperapps_FE_PWA/ |
git.gisportal.id/rbsetiawan/mysupperapps-fe-pwa |
mysupperapps_FE_PWA/docs/context-index.md |
Frontend PWA Next.js — https://my.gisportal.id |
Catatan mysupperapps_FE_PWA:
- Repo Git terpisah (microservice + FE UI) — sengaja dipisah dari monorepo LDAPWeb.
- Folder lokal di-ignore di
.gitignoreroot monorepo; commit & push hanya dari repo FE sendiri. - Backend API:
server-connection/geonet-console(console.gisportal.id/api/v1). - Pekerjaan full-stack: baca
docs/context-index.mdkedua repo (FE + backend).
Repository Ownership Policy
- Setiap repository memiliki dokumentasi, aturan, dan lifecycle masing-masing.
- Seluruh perubahan harus dilakukan pada repository yang benar.
- Jangan membuat dokumentasi lintas repository yang menyebabkan duplikasi informasi.
- Dokumentasi teknis harus tetap berada pada repository pemiliknya (Single Source of Truth).
Cross Repository Policy
Apabila sebuah pekerjaan melibatkan lebih dari satu repository:
- Identifikasi seluruh repository yang terdampak.
- Baca
docs/context-index.mddari setiap repository terkait. - Perbarui dokumentasi pada masing-masing repository yang mengalami perubahan.
- Dokumentasikan dependency dan integrasi antar repository apabila terjadi perubahan.
- Pastikan perubahan tetap kompatibel dengan repository lain.
Knowledge Preservation Policy
Setiap informasi yang diperoleh AI Agent selama proses:
- Analisis
- Debugging
- Development
- Testing
- Deployment
- Production Support
- Incident Handling
- Performance Tuning
- Security Review
yang berpotensi berguna di masa depan harus didokumentasikan pada repository yang sesuai.
AI Agent tidak boleh menyimpan konteks penting hanya di dalam percakapan.
Seluruh pengetahuan yang relevan harus dipindahkan ke dokumentasi repository agar dapat digunakan kembali oleh developer maupun AI Agent lain.
Documentation Policy (Mandatory)
Seluruh repository merupakan Single Source of Truth untuk proses development, deployment, operasi, dan maintenance.
Dokumentasi merupakan bagian dari source code dan memiliki prioritas yang sama dengan implementasi.
Setiap perubahan wajib didokumentasikan.
Minimal dokumentasi yang harus diperbarui apabila relevan:
- Feature Development
- Enhancement
- Bug Fix
- Known Issues
- Root Cause Analysis (RCA)
- Technical Debt
- TODO
- Next Action
- ADR (Architecture Decision Record)
- Changelog
- API Documentation
- Database Structure
- Database Migration
- Environment Configuration
- Infrastructure
- Server Information
- Deployment Guide
- CI/CD
- Monitoring
- Logging
- Dependency antar service
- Breaking Changes
- Security Notes
- Workaround
- Troubleshooting
- Performance Optimization
- Operational Notes
- Catatan penting lainnya yang mempengaruhi proses development maupun deployment.
Documentation Quality Standard
Dokumentasi harus:
- Akurat
- Ringkas
- Mudah dipahami
- Selalu diperbarui
- Tidak duplikat
- Konsisten dengan implementasi kode
- Menggunakan Markdown
- Mengacu pada
docs/context-index.md
Apabila dokumentasi sudah tersedia, lakukan pembaruan daripada membuat file baru.
AI Agent Responsibilities
Apabila AI Agent melakukan perubahan pada repository, maka AI Agent wajib:
- Memperbarui dokumentasi yang relevan.
- Memperbarui
docs/context-index.mdapabila terdapat dokumen baru. - Memperbarui TODO apabila status berubah.
- Memperbarui Issue apabila ditemukan bug baru.
- Membuat ADR apabila terdapat keputusan arsitektur baru.
- Memperbarui dokumentasi API apabila endpoint berubah.
- Memperbarui dokumentasi database apabila schema berubah.
- Memperbarui deployment guide apabila proses deployment berubah.
- Memperbarui changelog untuk setiap perubahan penting.
- Memastikan seluruh dokumentasi konsisten dengan implementasi kode.
- Menandai dokumentasi yang sudah tidak berlaku sebagai Deprecated, bukan langsung menghapusnya.
Commit Policy
Sebelum pekerjaan dianggap selesai:
- Review seluruh perubahan.
- Pastikan dokumentasi telah diperbarui.
- Pastikan tidak ada secret yang ikut ter-commit.
- Pastikan repository dapat dibangun dan dijalankan apabila memungkinkan.
- Buat commit yang jelas dan deskriptif.
- Jangan melakukan commit yang mencampurkan perubahan yang tidak berkaitan.
Definition of Done (DoD)
Sebuah pekerjaan belum dianggap selesai apabila salah satu kondisi berikut masih ada:
- Dokumentasi belum diperbarui.
- TODO belum diperbarui.
- Issue belum diperbarui.
- API belum diperbarui.
- ADR belum dibuat (jika diperlukan).
- Changelog belum diperbarui.
docs/context-index.mdbelum diperbarui apabila terdapat dokumen baru.
Notes
- Struktur workspace bersifat dinamis.
- Repository dapat ditambah, dipindahkan, atau dihapus.
- Pastikan daftar repository pada dokumen ini selalu diperbarui.
- Seluruh dokumentasi teknis berada di masing-masing repository.
Workspace-Context.mdhanya berfungsi sebagai navigasi dan entry point.- Selalu gunakan dokumentasi terbaru sebagai acuan sebelum melakukan analisis atau implementasi.
- Prioritaskan pembaruan dokumentasi yang sudah ada daripada membuat dokumentasi baru yang berpotensi duplikat.