Citation File Formatはリポジトリのルートからソフトウェアが自身を引用できるようにした

論文にはタイトルページがあるが、研究ソフトウェアにはしばしばそれがなかった。利用者はコードを見ることはできても、正確な著者リスト、バージョン、DOI、推奨される引用方法を知ることができず、ソフトウェアは一貫性なく引用されるか、まったく引用されなかった。

Citation File Formatは、ほとんどインフラを必要とせずにこれを解決した。メンテナーがプレーンテキストのYAMLファイルである`CITATION.cff`をリポジトリのルートに追加する。このファイルは、ソフトウェアやデータセットをどのように引用すべきかを人間と機械の両方に正確に伝える。

採用を後押ししたのはプラットフォームの対応だった。GitHubはCFFを読み取り、APAとBibTeXの出力を伴う「Cite this repository」プロンプトを表示する。ZenodoとZoteroは同じメタデータを再利用でき、著者に再入力を求めずに済む。

引用メタデータをコードのそばに置く

ファイル名は慣習的で、リポジトリのルートで見つけやすい。

YAMLはファイルを人間が書きやすいままに保ちつつ、検証や変換に十分な構造も備えていた。

プラットフォームによるレンダリングが、メンテナーの慣習をエンドユーザーのワークフローに変えた。

推奨引用により、ソフトウェアのメタデータを失うことなく、論文やデータセットを指し示すことができた。

帰属表示が課題である場合、最良の標準は、利用者がすでにプロジェクトを探す場所に置かれた小さなファイルかもしれない。

CFFはコードホスティングと学術引用の間の実用的な橋渡しとなった。GitHubはCITATION.cffファイルへの直接の対応を文書化し、それらをAPAとBibTeXにレンダリングする。一方、CFFプロジェクトはGitHub、Zenodo、Zoteroからの対応を挙げている。