rintaraINSIGHTS

Panduan · Pembangunan Aplikasi

Modul 7: Dokumentasikan Keadaan Semasa Aplikasi

Daripada keputusan manusia kepada arahan AI yang jelas, boleh diuji dan boleh diaudit.

Oleh Rintara10 MIN BACAANPertengahan

Hasilkan dokumen keadaan aplikasi yang membolehkan orang lain menjalankan, menyemak, menyelenggara dan meneruskan pembangunan dengan selamat.

Hasil pembelajaran

Dokumen State of the Application yang berasaskan bukti dan sepadan dengan versi kod semasa.

Gunakan contoh rekaan atau data yang telah dinyahkenal pasti. Jangan tampal kata laluan, kunci API, dokumen sulit atau data peribadi sensitif ke perkhidmatan AI awam.

Aliran kerja

  1. Bekukan versi atau commit yang didokumenkan.
  2. Kumpul bukti daripada kod, konfigurasi, migrasi dan ujian.
  3. Rekod apa yang siap, belum siap dan diketahui bermasalah.
  4. Sahkan arahan pemasangan, deploy, backup dan pemulihan.

Master Prompt Template

Bertindak sebagai jurutera dokumentasi teknikal. Audit repositori sebelum menulis dan jangan mereka maklumat.

Repositori dan versi sasaran:
[LOKASI REPOSITORI, BRANCH, COMMIT ATAU VERSI]

Hasilkan dokumen “State of the Application” dengan:
1. Ringkasan eksekutif dan tujuan aplikasi.
2. Versi, tarikh semakan dan skop yang diperiksa.
3. Stack, seni bina dan aliran data utama.
4. Peta direktori serta tanggungjawab komponen penting.
5. Keperluan pemasangan dan arahan menjalankan aplikasi.
6. Nama pemboleh ubah persekitaran tanpa mendedahkan nilainya.
7. Skema data, migrasi semasa, seed dan strategi backup.
8. Jadual fungsi: Siap/Separa/Belum/Disekat dengan bukti.
9. Route, API, peranan dan integrasi luar.
10. Status ujian: arahan, bilangan, keputusan dan ujian yang belum ada.
11. Cara deploy, health check, logging, rollback dan pemulihan.
12. Isu diketahui, risiko keselamatan, hutang teknikal dan batasan.
13. Keputusan seni bina penting dan sebabnya.
14. Cadangan tiga langkah seterusnya mengikut keutamaan.

Sertakan rujukan fail atau arahan yang menyokong setiap dakwaan teknikal. Tandakan “Tidak dapat disahkan” jika bukti tiada. Akhiri dengan checklist serah tugas.

Latihan praktikal

Berikan dokumen kepada orang yang tidak membangunkan aplikasi. Minta mereka menjalankan ujian dan mengenal pasti versi semasa hanya menggunakan dokumen tersebut.

Senarai semak tamat modul

  • Versi dan tarikh semakan jelas.
  • Arahan telah diuji, bukan sekadar disalin.
  • Rahsia tidak didokumenkan.
  • Isu, risiko dan langkah seterusnya dinyatakan.