Postingan lainnya
Cara membuat dokumentasi yang baik dan benar
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 :)
1 Jawaban:
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 linkhttps://docsify.js.org/#/[/link] , linkhttps://swagger.io/solutions/api-documentation/[/link], dll. (google "generate documentation")
Jenis <a href='https://www.freecodecamp.org/news/why-documentation-matters-and-why-you-should-include-it-in-your-code-41ef62dd5c2f/'>https://www.freecodecamp.org/news/why-documentation-matters-and-why-you-should-include-it-in-your-code-41ef62dd5c2f/</a> seperti, dokumentasi seputar aplikasinya, dokumentasi seputar programnya (misalnya kamu bisa lihat <a href='https://laravel.com/docs/6.x'>dokumentasi laravel</a> 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.
