En el trabajo, estoy a cargo de mantener la organización de una gran cantidad de datos variados en un sistema de archivos estándar. Parte de esto viene con una clasificación sensata (por similitud, necesidad, acceso de lectura / escritura, etc.), pero la parte más importante es realmente documentarlo: qué documentos / archivos / medios deben ir a dónde, qué no debe estar en este directorio, "para algo ligeramente diferente, ver ../../other-dir", etc.
Por el momento, he documentado esto usando un archivo de texto sin formato readme
en cada directorio que quiero documentar. Si alguien no está seguro de qué debe estar en cualquier directorio, lee ese archivo.
Esto funciona bien, pero parece extraño que tenga esta solución personalizada primitiva para un problema que cualquier responsable de una estructura de directorio no trivial debe experimentar. Todas las compañías que conozco, por ejemplo, tienen algún tipo de sistema de archivos compartido donde la terminología acordada para la categorización es importante. En mi experiencia, las personas solo tienen que aprender qué es qué mediante prueba y error y experimentación.
Permítame proponerle una mejor solución, y espero que pueda decirme si existe. Cualquier directorio en cualquier sistema de archivos puede tener un archivo de texto plano oculto llamado .readme
. Sus contenidos son descriptivos del lenguaje humano. Utiliza un marcado como Markdown, con poco más que hipervínculos en negrita, cursiva y (relativa) a otros directorios. Ahora, un explorador de archivos habilitado adecuadamente buscará un archivo llamado .readme
cada vez que muestre un directorio. Si existe, su contenido se analiza y se muestra en un panel discreto cerca del widget de ruta de directorio. Se puede hacer clic en cualquier enlace que contenga, y el usuario será llevado al directorio de destino de ese enlace.
Creo que el esfuerzo de implementar tal estándar se vería recompensado muchas veces en ganancias de usabilidad. Tendríamos, digamos, complementos para Nautilus, Konqueror, etc. Podría usarse para mostrar información de directorio en las listas de archivos estándar que sirven los servidores web. Y así.
Entonces, pregunta: ¿existe tal cosa? ¿Si no, porque no? ¿La gente piensa que es una idea que vale la pena?