Bagaimana Menulis Dokumentasi ala Programmer?
Published on June 17, 2025 · 6 min read
Pernah denger jokes ini?
"Code is like a joke. If you have to explain it, it's not that good."
Tapi sayangnya... realita di dunia programming: even the best jokes need subtitles. Termasuk kode kamu.
Waktu awal-awal jadi developer, saya pikir dokumentasi itu tugas QA atau tech writer. Saya pikir: "Toh kodenya udah jelas, tinggal baca aja."
Sampai akhirnya saya harus bantu debug modul yang ditulis orang lain - tanpa dokumentasi. Itu bukan coding... itu detektifan. Saya kayak Sherlock Holmes yang mencoba menyelidiki kenapa ada fungsi dengan nama aneh padahal isinya query SQL.
📌 Cara Nulis Dokumentasi yang Enak Dibaca
Ini mungkin bisa jadi cara sederhana dan realistis ala programmer:
1. README Adalah Gerbang Utama
Isi minimal:
- • Apa project ini?
- • Gimana cara install dan run?
- • Teknologi yang dipakai?
- • Struktur folder dan file penting
Anggap aja kamu lagi ngenalin rumah ke tamu baru. Jangan biarin mereka nyasar ke gudang duluan.
2. Comment Seperlunya
Bukan semua baris dikasih comment. Tapi bagian:
Logic kompleks
Shortcut atau asumsi khusus
Hal yang bisa bikin bingung nanti
3. Catat Hal-hal di Luar Kebiasaan
• Harus pakai env tertentu
• Port khusus
• Library versi non-standar
• Cara setup yang beda dari biasanya
Anggap aja kamu lagi nitip rumah ke teman, dan kamu kasih tahu: "Oh iya, pintunya agak macet ya, mesti didorong pakai bahu."
4. Gunakan Tools Kalau Bisa
📚 Swagger
Buat dokumentasi API yang interaktif
📝 JSDoc / TSDoc
Buat penjelasan fungsi di code
📄 Markdown
Buat catatan ringan dan README
📋 Notion / Confluence
Untuk wiki project internal
🧠 Intinya
Dokumentasi bukan karya sastra
Nggak perlu pakai kalimat berbunga. Cukup jelas, ringkas, dan fokus bantu orang ngerti why dan how.
Dokumentasi itu kayak peta harta karun. Bukan yang bikin kita tersesat, tapi yang bantu kita sampai ke tujuan.
Template README Sederhana
# Project Name
Brief description of what this project does.
## Tech Stack
- Next.js 15
- TypeScript
- Tailwind CSS
## Getting Started
### Prerequisites
- Node.js 18+
- npm or bun
### Installation
\`\`\`bash
npm install
npm run dev
\`\`\`
## Project Structure
\`\`\`
src/
├── app/ # App router pages
├── components/ # Reusable components
├── lib/ # Utilities
└── types/ # TypeScript types
\`\`\`
## Environment Variables
\`\`\`
DATABASE_URL=
API_KEY=
\`\`\`
## Contributing
Pull requests are welcome!🤔 Diskusi
Kamu sendiri, bagian mana dari dokumentasi yang paling sering kamu tulis? Atau... bagian mana yang paling sering kamu skip (dan akhirnya nyesel)? 😅
Yuk diskusi bareng di kolom komentar! 👇
Tags: #softwaredevelopment #techwriting #developerlife #codereview #programmertips