在工作中,我负责在标准文件系统上维护大量不同数据的组织。其中的一部分是合理的分类(通过相似性,需求,读/写访问等),但是实际上大部分是对其进行文档记录:哪些文档/文件/媒体应该放在哪里,该目录中不应该包含哪些内容, “有关稍微不同的内容,请参见../../other-dir”等。
目前,我已经readme
在要记录的每个目录中使用纯文本文件对此进行了记录。如果有人不确定任何目录中的内容,那么他们将读取该文件。
这项工作正常,但是对于具有非平凡目录结构的任何维护者都必须经历的问题,我拥有这种原始的自定义解决方案似乎很奇怪。例如,我所知道的每家公司都有某种共享文件系统,在这种系统中,对于分类达成共识的术语很重要。以我的经验,人们只需要通过反复试验和实验来了解什么。
因此,请允许我提出一个更好的解决方案,希望您可以告诉我是否存在。任何文件系统上的任何目录都可以具有名为的隐藏纯文本文件.readme
。它的内容是描述性的人类语言。它使用诸如Markdown之类的标记,仅具有到其他目录的粗体,斜体和(相对)超链接。现在,适当启用的文件浏览器将.readme
在显示目录时检查名为的文件。如果存在,则将其内容解析并显示在目录路径窗口小部件附近的醒目的窗格中。可以单击其中的任何链接,并将用户带到该链接的目标目录。
我认为,实施这样的标准所付出的努力将使可用性收益获得许多倍的回报。例如,我们将拥有Nautilus,Konqueror等的插件。它可用于在Web服务器提供的标准文件列表中显示目录信息。等等。
因此,问题是:是否存在这样的事情?如果没有,为什么不呢?人们认为这是一个值得的主意吗?