Panduan DCC HRIS

Memperbarui panduan

Cara membuat ulang screenshot dan HTML panduan setelah aplikasi berubah.

Susunan file

Path Isi
docs/manual/pages/*.md Isi panduan dalam bahasa Indonesia. Urutan menu mengikuti nama file.
docs/manual/site.json Judul, label tampilan, dan daftar bagian (start, employee, manager, admin, internal).
docs/manual/shots/*.spec.ts Script Playwright yang menelusuri aplikasi dan mengambil screenshot.
docs/manual/assets/ CSS dan JavaScript situs panduan.
docs/manual/build.mjs Generator HTML.
docs/manual/dist/ Hasil build. Tidak di-commit.

Screenshot tidak disimpan di git. Gambar selalu dibuat ulang dari kode versi yang sedang di-build, jadi panduan tidak tertinggal dari aplikasi. Panduan yang tampil di server dev berasal dari GitHub Release, bukan dari main (lihat Versi dan rilis).

Membuat ulang semuanya

  1. Nyalakan instance terisolasi berisi data contoh. Jam server dipatok ke 10.00 WIB, jadi tampilan absensi selalu sama:

    .claude/skills/verify-hr/scripts/verify.sh up
    
  2. Ambil semua screenshot. Gambar disimpan di .verify/manual-shots/:

    make manual-shots
    
  3. Build HTML ke docs/manual/dist/, lalu buka docs/manual/dist/index.html di browser:

    make manual
    
  4. Matikan instance:

    .claude/skills/verify-hr/scripts/verify.sh down
    

Script screenshot berjalan berurutan pada satu database. Setiap bab hanya mengubah data karyawan contoh yang ditugaskan untuknya, jadi bab-bab tidak saling mengganggu. Jika satu script gagal, jalankan down lalu up lagi supaya database kembali bersih sebelum mencoba ulang.

Menambah atau mengubah halaman

  1. Tulis atau ubah file docs/manual/pages/<nomor>-<slug>.md. Header file berisi title, section, roles (opsional), dan summary.
  2. Tambahkan screenshot di script docs/manual/shots/ dengan shot(page, "<nama>"), lalu rujuk dari halaman sebagai ![Keterangan](img/<nama>.png).
  3. Jalankan make manual-shots ARGS="<nama file spec>" untuk mengambil screenshot bab itu saja, lalu make manual.

Build gagal jika halaman merujuk screenshot yang belum ada. Pakai node docs/manual/build.mjs --allow-missing untuk melihat draf dengan penanda di tempat screenshot yang belum dibuat. Screenshot yang tidak dipakai halaman mana pun dilaporkan sebagai peringatan.

Kotak catatan ditulis sebagai kutipan yang diawali label tebal: > **Catatan:**, > **Tips:**, atau > **Penting:**.

Panduan DCC HRIS · Versi 0.1.0 (v0.1.0) · dibuat 11 November 2026