Tujuan
Skuad sing disebar luwih cepet nalika playbook, keputusan, lan piwulang ditulis kanthi cara sing bisa ditebak. Buku pandhuan iki njlèntrèhaké kepiye carane kita nangkep kawruh supaya orientasi tetep lancar, konteks ora tau kepepet ing DM, lan post-mortem bisa digunakake maneh minangka pager pengaman ing mangsa ngarep.
Prinsip nulis
- Kejelasan dhisik. Targetake basa sing bisa dituruti dening kanca tim anyar ing siji wacan. Pecah jargon kanthi nambahake cathetan sikil utawa entri glosarium sing njlentrehake.
- Akurasi tinimbang kacepetan. Verifikasi data, pranala, lan pemilik. Cuplikan konfigurasi sing salah mbuwang wektu luwih akeh tinimbang nganyari sing telat.
- Struktur ringkes. Jaga paragraf cendhak, luwih seneng dhaptar peluru, lan gunakake info kanggo peringatan utawa tips kritis.
- Sadar-audiens. Cocogake dokumen karo peran sing dituju. Pandhuan fasilitator kudu nyorot alat, wektu, lan mode gagal, dene buku pedoman kudu nuduhake prentah lan langkah-langkah pembatalan.
- Versi lan diduweni. Saben kaca ndhaptar tanggal “Dianyari” lan pemilik sing tanggung jawab kanggo njaga urip.
Siklus urip dokumentasi
Anggep dokumentasi minangka puteran terus-terusan sing ngiyupi SDLC sampeyan. Siklus urip pangembangan dokumentasi (DDLC) sing entheng njaga konten tetep anyar:
graph TD
A[Perencanaan] --> B(Analisis)
B --> C{Pangembangan Konten}
C --> D[Tinjauan & Panyuntingan]
D --> E(Penerbitan)
E --> F[Pangopènan & Nganyari]
F --> A
- Perencanaan: Tetepake cakupan, pamirsa, lan saluran publikasi. Pasangake dokumen karo asil sing bisa diukur (contone, nyuda wektu orientasi).
- Analisis: Wawancara ahli materi pelajaran, tinjau metrik, lan kumpulake tangkapan layar utawa ekspor data.
- Pangembangan konten: Gawe draf dokumen nggunakake cithakan bareng. Sematake diagram karo Mermaid ing endi kajelasan alur penting.
- Tinjauan & panyuntingan: Rutekake draf liwat paling ora siji kanca lan siji pemilik sing tanggung jawab kanggo akurasi lan nada.
- Penerbitan: Kirim liwat situs dokumentasi bareng, tandhani kaca supaya katon ing panelusuran lan navigasi sidebar.
- Pangopènan: Jadwalake tinjauan triwulanan. Arsipake utawa gabungake kaca sing lawas kanggo nyegah panyimpangan kawruh.
Alat ing tumpukan kita
- Nulis sing mentingake Markdown: Tulis ing VS Code utawa portal dokumen, jaga format tetep prasaja lan ramah-diff.
- Penerbitan statis: Astro + Starlight nggawe kaca sing cepet lan bisa digoleki kanthi navigasi sing dibangun.
- Diagram: Luwih seneng Mermaid kanggo arsitektur, alur kerja, lan wit keputusan supaya nganyari tetep ing kontrol versi.
- Kontrol versi: Kabeh dokumen ana ing jejere kode ing Git kanggo nggunakake maneh alur kerja tinjauan sing wis dikenal.
Ngluncurake
- Kenalake buku pandhuan sajrone orientasi tim lan retro sprint.
- Pasangake standar karo cithakan kanggo buku pedoman, keputusan, lan tinjauan insiden.
- Lacak “wektu-kanggo-konteks” (suwene kanca tim butuh wektu kanggo munggah) lan anyari buku pandhuan nalika ana gesekan.
- Rayakake kontribusi kanthi umum supaya karya dokumentasi dihargai ing jejere fitur pengiriman.