PANDUAN PORTOIN
Dari README Proyek ke Studi Kasus Website Portoin
README menjelaskan penggunaan serta struktur proyek kepada pengguna atau developer. Studi kasus portofolio menjelaskan masalah, kontribusi, dan hasil kepada pembaca profesional. Gunakan materi README sebagai sumber, lalu sesuaikan uraian agar dapat dipahami tanpa membaca seluruh repositori.
Ambil konteks sebelum detail instalasi
Mulai dari tujuan aplikasi atau alat, pengguna, dan masalah yang ditangani. Jelaskan apakah proyek individu atau tim. Langkah instalasi panjang tidak perlu menjadi paragraf pertama portofolio.
Pilih teknologi yang benar-benar digunakan dan jelaskan perannya ketika penting. Menyebut banyak pustaka tanpa alasan tidak menunjukkan pemahaman. Beri link repositori jika dapat dibuka dan memang boleh dipublikasikan.
Tunjukkan keputusan dan bukti
Ringkas keputusan utama, tantangan, serta pengujian yang dilakukan. Gunakan screenshot, diagram, atau video untuk membantu pembaca melihat hasil. Jangan menjadikan demo berjalan sebagai bukti bahwa semua fitur sudah teruji.
Bedakan kemampuan yang sudah selesai dari rencana pengembangan. Jika proyek masih memiliki keterbatasan, jelaskan dengan singkat. Hapus token, konfigurasi privat, dan informasi akun dari repositori serta gambar yang dibagikan.
Buat versi yang mudah dibaca
Di Portoin, gunakan sampul untuk hasil utama dan uraian untuk konteks. Galeri menjelaskan detail, sementara link repositori menyediakan informasi teknis lanjutan. CV dapat merangkum kontribusi dalam beberapa butir.
Coba baca halaman sebagai orang yang belum melihat kode. Jika tujuan dan peran Anda belum jelas, perbaiki penjelasan sebelum menambah detail teknis. Portofolio dan README sebaiknya saling melengkapi sesuai pembacanya.