Di tempat kerja, saya bertanggung jawab untuk mengelola seluruh data yang bervariasi pada sistem file standar. Sebagian dari ini datang dengan klasifikasi yang masuk akal (berdasarkan kesamaan, kebutuhan, akses baca / tulis, dll), tetapi bagian yang lebih besar sebenarnya mendokumentasikannya: dokumen / file / media apa yang harus dituju, apa yang seharusnya tidak ada dalam direktori ini, "untuk sesuatu yang sedikit berbeda, lihat ../../other-dir", dll.
Saat ini, saya telah mendokumentasikan ini menggunakan file plaintext readme
di setiap direktori yang ingin saya dokumentasikan. Jika seseorang tidak yakin apa yang dimaksudkan dalam direktori apa pun, mereka membaca file itu.
Ini berfungsi dengan baik, tetapi tampaknya aneh bahwa saya memiliki solusi kustom primitif ini untuk masalah yang harus dialami oleh setiap pengelola struktur direktori non-sepele. Setiap perusahaan yang saya kenal, misalnya, memiliki semacam sistem file bersama di mana terminologi yang disepakati untuk kategorisasi adalah penting. Dalam pengalaman saya, orang hanya perlu belajar apa dengan percobaan-dan-kesalahan dan eksperimen.
Jadi izinkan saya untuk mengusulkan solusi yang lebih baik, dan mudah-mudahan Anda dapat memberi tahu saya jika itu ada. Direktori apa pun pada sistem file apa pun dapat memiliki nama file plaintext tersembunyi .readme
. Isinya adalah bahasa manusia deskriptif. Ini menggunakan beberapa markup seperti penurunan harga, dengan sedikit lebih dari tebal, miring, dan (relatif) hyperlink ke direktori lain. Sekarang browser file yang diaktifkan dengan tepat akan memeriksa file bernama .readme
setiap kali menampilkan direktori. Jika ada, isinya diurai dan ditampilkan dalam panel yang tidak mencolok di dekat widget jalur-direktori. Tautan apa pun di dalamnya dapat diklik, dan pengguna akan dibawa ke direktori target tautan itu.
Saya pikir upaya penerapan standar semacam itu akan membayarkan berkali-kali lipat dalam keuntungan usabilitas. Kami akan memiliki, misalnya, plugin untuk Nautilus, Konqueror, dll. Ini dapat digunakan untuk menampilkan informasi direktori dalam daftar file standar yang dilayani oleh webserver. Dan seterusnya.
Jadi, pertanyaan: apakah hal seperti itu ada? Jika tidak, mengapa tidak? Apakah orang berpikir itu ide yang bermanfaat?