standar-dokumentasi.md
docs/standar-dokumentasi.md
Contoh isi file untuk sistem antrian. Sesuaikan dengan implementasi proyek Anda.
# Standar Dokumentasi Backend — Mandatory
Mulai dari [docs/README.md](README.md), lalu isi berdasarkan implementasi nyata.
| Folder | Isi standar | Contoh |
| --- | --- | --- |
| 01-overview | Scope, aktor, dependency, PIC dan link proyek | system-context.md, container-diagram.md |
| 02-business-flow | Alur aplikasi, validasi, rule, kasus gagal | application-flow.md, business-rules.md |
| 03-api | Kontrak, autentikasi, error, collection | authentication.md, error-codes.md, bruno/ |
| 04-database | Ownership, model, field, constraint, migration | erd.md, data-dictionary.md |
| 05-architecture | Interaksi komponen dan keputusan desain | sequence-diagrams.md, adr/ |
| 06-operations | Setup/deploy, config, monitoring, pemulihan | deployment.md, environment.md, monitoring.md, incident-runbook.md |
Dokumentasi standar dan Bruno wajib tersedia. Diagram, OpenAPI, ADR, dan runbook sebagai file terpisah opsional; contoh disediakan agar tim dapat mengembangkannya saat dibutuhkan. Tuliskan “Tidak berlaku” beserta alasan untuk area yang tidak relevan.
## Pemeliharaan
- Perbarui dokumen dan docs/03-api/bruno/ dalam MR yang sama dengan kode terkait.
- Reviewer memeriksa kontrak, cara setup/test, migration, dan prosedur operasional.
- Semua perubahan database wajib migration/versioned script.
- Catat command lint/test/build yang benar-benar tersedia pada backend proyek.
- Tautkan JIRA dan Production Release Record untuk fitur, versi, migration, approval, dan hasil deployment.
- Gunakan data sintetis; jangan menyimpan credential atau data pribadi.