Skip to content

Menulis halaman INACT

Cara menambah atau memperbarui halaman di bagian ini. Aturannya ada supaya pembaca yang kenal satu halaman bisa menemukan jalannya di halaman lain mana pun, dan supaya sebuah halaman bisa diperiksa kebasiannya kelak.

Sebelum menulis

  • Periksa kodenya, bukan ingatanmu. Setiap klaim yang tidak jelas dengan sendirinya menunjuk ke file, key config, tabel atau commit. Kalau kamu tidak bisa menunjuknya, tulis baris > **TODO:** alih-alih menebak. Halaman tipis yang jujur lebih baik daripada halaman penuh dengan tiga baris yang salah.
  • Periksa big five, bukan satu fork: inact, ina-jadestone, ina-medco-v3, ina-jotre, ina-primaenergy. Grep masing-masing. Perbedaan masuk ke tabel Perbedaan antar instance; yang tidak kamu periksa masuk ke verified_on.
  • Periksa bahwa jalurnya aktif. Fungsi yang ada bisa mati: helper query legacy melempar exception begitu masuk di empat dari lima fork. Sebutkan jalur mana yang mati di mana.
  • Kedua locale, setiap saat. Bahasa Inggris di bawah src/inact/, Bahasa Indonesia di bawah src/id/inact/, struktur yang sama, dan entri sidebar di kedua locale di src/.vitepress/config.mjs. Halaman belum selesai sampai keduanya ada.

Frontmatter

yaml
---
last_verified: 2026-09-06
verified_on: [inact, ina-jadestone, ina-medco-v3, ina-jotre, ina-timas]
sources:
  - modules/routing/routing_handler_post.php
  - templates/tracking_v2/routing_resp.htm
---

verified_on mencantumkan repository tempat klaim diperiksa. sources adalah path relatif terhadap repository master. Perbarui last_verified setiap kali kamu memeriksa ulang halaman, meski tidak ada yang berubah.

Bagian-bagiannya, dengan urutan ini

Untuk halaman fitur atau modul:

  1. Satu baris modul dan ringkasan singkat: untuk apa fiturnya, dan apa yang tidak dilakukannya.
  2. Kotak ::: info Cara halaman ini diverifikasi: kapan, di fork mana, apa yang diperiksa ulang.
  3. Alur pengguna atau Layarnya: tombol, privilege, dialog.
  4. Cara kerjanya: titik masuk, handler, fungsi kunci, efek samping. Tautkan kode sebagai https://github.com/binari-digital/inact/blob/main/<path>, jangan pernah dengan nomor baris.
  5. Kontrak data atau template bila ada file atau struktur tetap yang terlibat.
  6. Tabel database yang terpengaruh: tabel, operasi, oleh siapa.
  7. Hal yang perlu diwaspadai: kegagalan diam-diam, jalur mati, keanehan validasi.
  8. Perbedaan antar instance: satu baris per fork yang berbeda dari master. Kalau tidak ada yang berbeda, tulis "Tidak ada" dan sebutkan fork yang diperiksa.
  9. Terkait: tautan ke halaman tetangga.

Untuk halaman sistem (konfigurasi, kontrol akses, reporting) sesuaikan judulnya; pertahankan kotak verifikasi, tabel, hal yang perlu diwaspadai dan Perbedaan antar instance.

Untuk halaman instance, ikuti enam yang sudah ada: bagian yang sama, urutan yang sama.

Menandai kekhususan di dalam halaman

md
::: warning Hanya Medco
Tab "Ready to Return" hanya ada di `ina-medco-v3`.
:::

Pakai ::: danger untuk sesuatu yang gagal atau menyesatkan, ::: warning untuk perbedaan, ::: tip untuk bantuan membaca.

Bahasa

Halaman Inggris dulu, lalu halaman Bahasa Indonesia. Istilah domain tetap dalam bahasa Inggris di keduanya: MDR, Transmittal, Document Library, sign off, routing, dan setiap nama tabel, kolom dan fungsi. Kalimat pendek. Sebutkan poin utama lebih dulu.

Saat tiket menyentuh modul tanpa halaman

Tulis halamannya sebagai bagian dari tiket, pada tingkat detail yang dibutuhkan tiket, dengan bagian-bagian di atas. Halaman yang memetakan modul dan mencantumkan jalur matinya lebih berguna daripada tanpa halaman. Tambahkan ke kedua sidebar dan ke rencana di plans/inact-docs.md.

Memeriksa halaman kelak

Telusuri last_verified. Halaman yang lebih tua dari setahun, atau yang sources-nya berubah di git sejak tanggal itu, diperiksa ulang: buka kodenya, konfirmasi setiap klaim, perbaiki teksnya, naikkan tanggalnya.