はじめに

こんにちは！ご訪問いただき、ありがとうございます！

僕は現在、エンジニアとしての就職を目指しながら、インボイス制度に対応した請求書を、Web上で作成・発行できるサービスの開発をしています。

その開発を進めていく中で、読んでもらえるREADMEを作成したいという想いから、世の中の開発者がどのようにREADMEを作成しているのかを、GitHubで調べて分析をしました。

本記事では、たくさんのREADMEを見て学んだ、読みたくなるREADMEを書くためのコツを、実際に僕が作成したREADMEを例にしてご紹介します。

実際に作成したREADME

今回ご紹介する内容は、未経験でエンジニア就活をする際に、採用担当の方が読みたくなるようなREADMEを作成することを目的とした内容となります。

また、実際に作成したREADMEを例にコツのご紹介していますが、時間の兼ね合いで、学んだコツを反映できていない部分も多々あります。

あくまで参考資料として、ご覧いただけましたら幸いです。

読みやすいREADMEは、以下の構成がベースになっていることが多いです。

読み手が知りたいことを知りたい順番で書く。
想定している読み手やサービスの特徴によって、項目の追加や削除、内容の厚さの調整をする。

ここまでブロックごとにコツを書いてきましたが、最後に全体を通してのコツをご紹介します。

今回は、沢山のREADMEをみて学んだ、読みたくなるREADMEを作成するコツをご紹介しました。
READMEの作成に困った時は、またいつでも、こちらにいらしてください。
ここまでご覧いただき、ありがとうございました。