オープンソースソフトウェア開発におけるREADME記述項目の分析

池田 祥平 (1651008)


本発表では,オープンソースソフトウェア(OSS)プロジェクトの開発者に対してREADME作成時の方針を与えることを目的として,READMEを公開するソフトウェアの内,多くのREADMEで共通して記述される項目を明らかにする.OSSプロジェクトにおいてREADMEは,ソフトウェアを正しく使用するためのインストール方法や利用例などのソフトウェアを正しく使用するための方法,プロジェクトへの貢献方法などの開発を促進するための方法を共有するために重要なドキュメントである.READMEの品質を向上させるため,READMEに記述する項目のガイドラインが存在する.しかしすべてのREADMEがガイドラインに準拠しているか否かは明らかではなく,またガイドラインがあらゆるソフトウェア種別のREADMEに適用可能であるかも明らかでない.本発表では,READMEに記述される項目を明らかにするために,既存のREADMEに記述された項目を抽出し,ソフトウェア種別に記述項目を比較した結果を発表する.43,991件のプロジェクトを対象に分析した結果,READMEにはガイドラインに示されているインストール方法,利用方法,ライセンスが最も頻繁に記述されていたが,すべてのREADMEに記述されているわけではなかった.ソフトウェア種別に記述項目を比較すると,アプリケーションパッケージには多数の機能を説明する項目が,ライブラリパッケージではインストール方法とライセンスが他方に比べ頻繁に記述されていた.ソフトウェア種別に重視する項目の違いは,OSSプロジェクトの開発者が自身のソフトウェア種別に合わせたREADMEを作成する方針となりうる.