タグ

ブックマーク / qiita.com/ren_ichinose (1)

  • 読みたくなるREADMEを書くためのコツ - Qiita

    はじめに こんにちは!ご訪問いただき、ありがとうございます! 僕は現在、エンジニアとしての就職を目指しながら、インボイス制度に対応した請求書を、Web上で作成・発行できるサービスの開発をしています。 その開発を進めていく中で、読んでもらえるREADMEを作成したいという想いから、世の中の開発者がどのようにREADMEを作成しているのかを、GitHubで調べて分析をしました。 記事では、たくさんのREADMEを見て学んだ、読みたくなるREADMEを書くためのコツを、実際に僕が作成したREADMEを例にしてご紹介します。 実際に作成したREADME 前提 今回ご紹介する内容は、未経験でエンジニア就活をする際に、採用担当の方が読みたくなるようなREADMEを作成することを目的とした内容となります。 また、実際に作成したREADMEを例にコツのご紹介していますが、時間の兼ね合いで、学んだコツを反

    読みたくなるREADMEを書くためのコツ - Qiita
    okinaka
    okinaka 2023/08/07
  • 1