Panduan Berbagi Catatan & Panduan di KATAKATING

1. Dari Mahasiswa, untuk Mahasiswa

KATAKATING adalah wadah repositori terbuka bagi mahasiswa Universitas Boash untuk saling berbagi catatan praktikum, rangkuman materi perkuliahan, dan panduan akademik mandiri.

Tujuan portal ini adalah memastikan catatan dan pengalaman lab yang telah dipelajari dapat terdokumentasi rapi, terstruktur, serta bermanfaat bagi sesama rekan mahasiswa dan angkatan selanjutnya.

2. Kategori Catatan yang Didukung

Naskah dapat diajukan sesuai rumpun bidang keilmuan yang tersedia:

1. Jaringan Komputer: Konfigurasi router, switch, VLAN, routing statis/dinamis, subnetting, dan simulasi Cisco Packet Tracer.
2. Web & Tooling: Panduan frontend/backend, instalasi environment, WSL2, Docker, Node.js, dan framework web modern.
3. Basis Data: Perancangan ERD, sintaks SQL, normalisasi tabel (1NF hingga 3NF), PostgreSQL, dan MySQL.
4. Algoritma & Pemrograman: Struktur data, rekursi, algoritma sorting/searching dalam C++, Java, atau Python.
5. IoT & Embedded System: Skema mikrokontroler ESP32/Arduino, protokol MQTT, sensor, dan simulasi Wokwi.
6. Game & Multimedia: Pemodelan 3D Blender, pipeline Unity, audio, dan metodologi MDLC.
7. Akademik & Laporan: Format margin baku 4-4-3-3, tata tulis ilmiah, template Word, dan panduan sidang tugas akhir.
8. Git & DevOps: Workflow branching, mitigasi merge conflict, CI/CD pipeline, dan deployment cloud.

3. Unduh Template Naskah Praktikum

Untuk mempermudah penulisan, telah disediakan tiga pilihan format berkas siap pakai yang dapat diunduh dan disesuaikan:

4. Alur Pengajuan Catatan di Web

1. Akses Halaman Upload: Buka menu Upload di bilah navigasi utama atau menu bawah ponsel.
2. Unggah Berkas Naskah: Sistem dilengkapi konverter berkas otomatis. Kamu dapat mengunggah berkas Word (.docx), PDF Digital (.pdf), Teks (.txt), maupun Markdown (.md). Konten akan diekstrak langsung ke formulir.
3. Lengkapi Metadata Naskah:
   • Judul Catatan: Tulis judul materi yang spesifik dan jelas.
   • Kategori: Pilih bidang keilmuan yang sesuai.
   • Nama Penulis & NIM: Cantumkan identitas lengkap untuk atribusi kontribusi.
   • Ringkasan (Abstrak): Berikan 1–2 kalimat ringkasan inti bahasan catatan.
   • Tags (Opsional): Kata kunci pencarian yang dipisahkan tanda koma.
4. Kirim & Peroleh Tiket Antrean: Klik tombol Ajukan. Sistem akan menerbitkan kode tiket naskah (contoh: SUB-1024) sebagai bukti pengajuan.
5. Kurasi & Publikasi: Tim kurasi memeriksa kelayakan format dan orisinalitas naskah di panel moderasi. Setelah disetujui, catatan langsung tayang di katalog publik dan graf pengetahuan.

5. Etika & Standar Kontribusi

• Orisinalitas Materi: Naskah merupakan hasil penulisan mandiri atau laporan praktikum kelompok yang sah, bukan duplikasi tanpa izin.
• Atribusi & Rujukan: Cantumkan modul lab dosen, dokumentasi resmi, atau literatur yang dijadikan acuan pada bagian akhir naskah.
• Kerapian Format: Gunakan blok kode untuk sintaks terminal/pemrograman, sertakan hasil pengujian langkah kerja, dan terapkan bahasa yang lugas.

6. Kolaborasi Open-Source via Git & Pull Request

Bagi rekan-rekan mahasiswa teknik dan software engineering yang terbiasa bekerja di lingkungan terminal, Git, dan Neovim / VS Code, repositori KATAKATING dikembangkan secara terbuka (open-source). Kamu dapat berkontribusi langsung menambahkan modul catatan atau menyempurnakan fitur web melalui alur Git Pull Request:

1. Clone Repositori:

git clone https://github.com/muadzhdz/katakating.git
cd katakating

2. Buat Naskah Baru: Tambahkan berkas catatan berformat Markdown di folder notes/nama-catatan.md dan daftarkan metadatanya di notes/notes.json.

3. Uji Validasi & Build:

npm install
npm test
npm run build

4. Kirimkan Pull Request: Buka Pull Request ke branch main di repositori GitHub muadzhdz/katakating. Tim pengembang akan meninjau dan menggabungkan kontribusi kamu secara langsung ke naskah resmi!