You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
32 lines
1.2 KiB
32 lines
1.2 KiB
--- |
|
description: Kapan dan bagaimana harus update dokumentasi |
|
globs: ["**/*.md", "**/*.php", "**/*.ps1"] |
|
alwaysApply: true |
|
--- |
|
|
|
# Documentation Rules |
|
|
|
## Wajib Update Setelah: |
|
|
|
- **Endpoint API baru/berubah** → update `geonet-console/docapi/index.md` + buat `docapi/services/<service>/<endpoint>.md` |
|
- **Perubahan arsitektur** → update `docs/architecture/` + buat ADR baru di `docs/adr/` |
|
- **Env var baru** → update `geonet-console/.env.example` + `docs/environment.md` |
|
- **Bug fix penting** → tambah ke `docs/issues.md` (section Fixed) |
|
- **Deploy procedure berubah** → update `docs/deployment.md` |
|
- **Server/infra berubah** → update `docs/server.md` + `.cursor/me.md` |
|
- **Akhir sesi pengembangan** → update `perintah.md` (Sync terakhir) |
|
|
|
## ADR Rules |
|
|
|
- ADR = Architecture Decision Record — tidak pernah dihapus |
|
- Jika keputusan berubah → buat ADR baru yang references ADR lama |
|
- Simpan di `docs/adr/ADR-NNNN-judul.md` |
|
- Status: Proposed / Accepted / Superseded / Deprecated |
|
|
|
## Definition of Done |
|
|
|
Implementasi dianggap selesai jika: |
|
- [ ] Code bekerja dan test lulus |
|
- [ ] `docapi/` diperbarui (untuk perubahan API) |
|
- [ ] `perintah.md` diperbarui (Sync terakhir) |
|
- [ ] Tidak ada secret/credential di code atau dokumentasi
|
|
|