Kode dibaca jauh lebih sering daripada ditulis. Section ini membahas praktik yang menjaga project tetap sehat setelah rilis pertama: docstring, dokumentasi teknis, refactoring, dan prinsip desain yang membantu kode bertahan bertahun-tahun.

# Menulis Docstring

Kuasai gaya docstring Google, NumPy, dan reST lengkap dengan Args, Returns, Raises, serta doctest teruji.

Buka → # Dokumentasi dengan Sphinx

Bangun dokumentasi HTML profesional dari docstring dengan Sphinx: autodoc, napoleon, intersphinx, dan proses build.

Buka → # Dokumentasi dengan MkDocs

Susun dokumentasi proyek modern berbasis Markdown dengan MkDocs: struktur nav, tema Material, mkdocstrings, dan deploy.

Buka → # Type Hints untuk Maintainability

Gunakan type hints dan mypy sebagai kontrak yang menjaga refactor tetap aman saat kode berkembang dari waktu ke waktu.

Buka → # Refactoring

Ubah struktur kode tanpa mengubah perilaku: ekstrak fungsi, konstanta, dict dispatch, dan guard clause.

Buka → # Code Review

Jalankan review yang membangun: checklist kualitas, etika umpan balik, pemeriksaan otomatis, dan disiplin PR kecil.

Buka → # Design Principles

Terapkan SOLID, composition over inheritance, DRY, KISS, serta kohesi dan kopling agar kode mudah dikembangkan.

Buka → # Menjaga Backward Compatibility

Jaga API tetap ramah bagi pengguna lama: proses deprecasi, semver, changelog, dan teknik kompatibilitas tanpa patah.

Buka →