投稿

[GitHub 100日チャレンジ] Day 14 - README.mdを構造化する

READMEを見出し、目次、セットアップ、使い方、ライセンスなどのセクションに分けて読みやすくする方法を説明します。

[GitHub 100日チャレンジ] Day 14 - README.mdを構造化する

構造化が必要な理由

READMEが長くなると、ただ文章を並べるだけでは読みにくくなります。セクションを分けることで、読み手が必要な情報にすぐたどり着けます。

よく使う構成

1
2
3
4
5
6
7
8
# Project name

## Overview
## Features
## Setup
## Usage
## Roadmap
## License

すべての項目を必ず入れる必要はありません。プロジェクトに合うものだけ選びます。

読みやすくするコツ

  • 最初に結論を書く
  • 見出しを短くする
  • 手順は番号付きにする
  • コマンドはコードブロックにする
  • スクリーンショットは必要な場所だけ使う

今日のゴール

Day 13で作ったREADMEを、見出しごとに整理して読みやすくしましょう。

この投稿は投稿者によって CC BY 4.0 の下でライセンスされています。