Untuk mendokumentasikan sumber kumpulan data di Mac, buat README teks biasa di samping data dan catat penyedia, halaman atau pengidentifikasi asli, tanggal pengunduhan, versi, lisensi, dan setiap perubahan yang Anda buat. Simpan catatan tersebut bersama file proyek agar sumbernya dapat ditemukan kembali meskipun tag Finder, penanda (bookmark), atau riwayat unduhan hilang. Panduan ini ditujukan bagi pengguna Mac yang bekerja dengan folder proyek lokal.

Buat catatan sumber di samping kumpulan data

Di Finder, buka folder proyek dan pilih File > Folder Baru (atau tekan Shift-Command-N) jika Anda memerlukan folder untuk file asli dan dokumentasinya. Beri nama yang jelas, seperti data-source, atau simpan catatan tersebut di folder yang sudah berisi kumpulan data. Apple mendokumentasikan perintah folder Finder ini; menyimpan metadata dekat dengan data mengikuti panduan pemerintah untuk mencatat informasi kumpulan data. Mengatur file Anda di Finder di Mac, Mencatat informasi tentang kumpulan data yang Anda bagikan dengan orang lain

Buka TextEdit dari Aplikasi atau Spotlight. Pilih Format > Jadikan Teks Biasa, lalu buat dokumen baru. Teks biasa adalah pilihan praktis karena dapat dibuka tanpa aplikasi pengolah kata yang sama dan mudah dibaca berdampingan dengan kumpulan data; Cornell Data Services merekomendasikan teks biasa untuk file README data. Simpan di folder yang sama dengan kumpulan data sebagai README.txt atau README.md. Jika dialog penyimpanan TextEdit mengusulkan ekstensi teks kaya (rich-text), periksa nama file dan formatnya sebelum menyimpan; kata-kata menu dan dialog dapat bervariasi menurut versi macOS. Menulis README untuk Data Penelitian

Catat detail yang cukup untuk mengidentifikasi sumber secara tepat

Gunakan catatan ringkas seperti berikut, dengan mengganti setiap petunjuk sesuai informasi yang dapat Anda verifikasi. Biarkan bidang ditandai "tidak diketahui" jika Anda tidak dapat memastikannya; jangan menebak-nebak.

  • Judul kumpulan data dan nama file:
  • Penyedia atau pembuat asli:
  • URL halaman sumber atau pengidentifikasi persisten:
  • Versi, rilis, atau tanggal publikasi:
  • Tanggal diperoleh (YYYY-MM-DD):
  • Lisensi atau ketentuan penggunaan kembali, sebagaimana dinyatakan oleh penyedia:
  • Cakupan atau isi yang relevan dengan proyek ini:
  • Perubahan yang dilakukan pada salinan yang diunduh:
  • File atau dokumentasi terkait:

URL halaman sumber harus mengarah ke halaman kumpulan data penyedia jika tersedia, bukan hanya ke tautan unduhan sementara. Tambahkan pengidentifikasi seperti DOI jika penyedia menyediakannya. Standar katalog kumpulan data membedakan halaman arahan (landing page), penerbit, lisensi, versi, dan asal-usul (provenance) kumpulan data; mencatat hal-hal ini secara terpisah mempermudah mengetahui dari mana salinan berasal dan rilis mana yang diwakilinya. Standar data: Kumpulan Data

Catat tanggal saat Anda mengunduh atau menerima file tersebut, bukan seolah-olah itu adalah tanggal kumpulan data tersebut dibuat. Jika Anda dapat memverifikasi tanggal rilis atau pembaruan penyedia, beri label secara terpisah. Gunakan judul penyedia yang sebenarnya dan tuliskan nama organisasi secara lengkap alih-alih mengandalkan singkatan yang ambigu. Panduan GOV.UK merekomendasikan untuk mengidentifikasi siapa yang membuat kumpulan data, kapan kumpulan data tersebut dibuat, dan pengidentifikasi yang jelas, serta menyarankan penggunaan "tidak diketahui" ketika informasi tidak tersedia. Mencatat informasi tentang kumpulan data yang Anda bagikan dengan orang lain

Jelaskan apa yang terjadi setelah pengunduhan

Catatan sumber harus membedakan data asli penyedia dari versi yang digunakan dalam proyek Anda. Nyatakan apakah Anda mengganti nama file, memfilter baris, menggabungkan sumber, mengonversi format, atau mengoreksi nilai. Jika data tidak berubah, nyatakan demikian hanya jika Anda memastikannya. Untuk file turunan, identifikasi nama file input dan rangkum operasinya; tautkan ke skrip atau catatan analisis jika berisi langkah-langkah yang dapat direproduksi. Panduan dokumentasi data Sandia secara khusus merekomendasikan untuk menyebutkan sumber asli untuk data turunan dan mencantumkan langkah-langkah pemrosesan. Dokumentasi Data – Berbagi Data FAIR(ER)

Misalnya, tulis “Difilter ke baris bertanggal 2022–2024; disimpan sebagai sales_2022_2024.csv” hanya jika hal itu secara akurat menggambarkan pekerjaan Anda. Jangan mengganti file asli secara diam-diam: simpan salinan yang belum diubah jika memungkinkan dan berikan nama file yang berbeda pada output yang diubah. Jika halaman penyedia mencantumkan lisensi atau batasan penggunaan, catat kata-kata yang tertera atau tautkan ke sana; catatan ini membantu menemukan ketentuan tetapi tidak menggantikan kewajiban memeriksa apakah rencana penggunaan Anda diizinkan.

Gunakan tag Finder hanya sebagai pintasan

Tag Finder dapat membantu Anda menemukan kumpulan data atau README nanti. Pilih item di Finder, pilih File > Tag, atau Control-klik item tersebut dan pilih tag. Apple menyatakan bahwa tag dapat digunakan untuk menemukan item yang diberi tag dari bar samping Finder atau pencarian; tag adalah label untuk menemukan file, bukan pengganti untuk mendokumentasikan penyedia, rilis, dan perubahan dalam README. Menggunakan tag untuk mengatur file di Mac

Sebelum menganggap sumber telah terdokumentasi, buka README dari folder proyek dan periksa apakah nama filenya sesuai dengan file yang Anda gunakan, URL atau pengidentifikasinya cukup spesifik untuk mengambil kembali sumbernya, dan setiap tanggal memiliki arti yang jelas. Jika Anda tidak dapat mengidentifikasi versi persisnya, nyatakan keterbatasan tersebut dalam catatan. Catatan yang singkat dan akurat lebih berguna daripada mengisi setiap bidang dengan asumsi.

Sumber