解决方案
论文有标题页;研究软件往往没有。用户能看到代码,却看不到确切的作者名单、版本、DOI或首选引用方式,因此软件被引用得不一致,或者根本未被引用。
引用文件格式几乎不需要任何基础设施就解决了这个问题。维护者在仓库根目录添加`CITATION.cff`,这是一个纯文本YAML文件。该文件告诉人和机器如何准确引用该软件或数据集。
推广的杠杆是平台支持。GitHub读取CFF并显示“引用此仓库”的提示,提供APA和BibTeX输出;Zenodo和Zotero可以复用同一套元数据,而不必要求作者重新录入。
取得了什么成果
把引用元数据放在代码旁边
为什么有效
文件名是约定俗成的,并且在仓库根目录易于发现。
YAML让文件保持人类可写,同时结构足够规范,可用于验证和转换。
平台渲染把维护者的约定变成了终端用户的工作流。
首选引用让软件可以指向某篇论文或某个数据集,同时不丢失软件元数据。
可以借鉴什么
当问题出在署名归属上时,最好的标准也许就是在用户本来就会查看项目的位置放一个极小的文件。
后续影响
CFF成为代码托管与学术引用之间的实用桥梁。GitHub的文档说明其直接支持CITATION.cff文件,并将其渲染为APA和BibTeX,而CFF项目则指出其获得了GitHub、Zenodo和Zotero的支持。
从这里,追溯依据
参考来源
- Citation File Format (CFF) - Specifications Zenodo · zenodo.org ·
- About CITATION files GitHub Docs · docs.github.com