Daftar dan Belajar Sekarang!

Cara membuat dokumentasi yang baik dan benar

foto ichsanmln99
5 Kontribusi 0 Coto
4 bulan yang lalu
hallo, sharing tips dong, gimana kalian membuat dokumentasi aplikasi kalian? seperti apakah ada aturan yang dipakai, atau ada tools yang membuat dokumentasi lebih mudah, terus apakah ada referensi yang bisa saya jadikan acuan dalam membuat dokumentasi? terima kasih :)

Jawaban
foto hilmanski
2148 Kontribusi 1720 Coto
4 bulan yang lalu
tujuan dokumentasi sebenarnya agar mudah untuk developernya mengurus aplikasi tersebut. Kamu bisa membuat dokumentasinya sendiri kalau tidak terlalu banyak (skalanya tidak begitu besar), mmebuat html/css sendiri atau menulis dokumen biasa, yang penting disana informasinya bisa membantu kamu Ada banyak juga tool untuk membuat dokumentasi secara automatis, seperti docsify , swagger, dll. (google "generate documentation") Jenis dokumentasi juga ada jenisnya seperti, dokumentasi seputar aplikasinya, dokumentasi seputar programnya (misalnya kamu bisa lihat dokumentasi laravel yg menurut saya bagus banget) Bisa dimulai dari tanyakan, dokumentasi ini untuk siapa? untuk kamu sendiri? untuk tim kamu yang akan datang? untuk open source (banyak yang akan melihat) dst.


Login untuk diksusi di forum sekolah koding