[GitHub 100日チャレンジ] Day 76 - GitHub Wikiを作る

GitHub Wikiとは

GitHub Wikiは、Repositoryに付属するドキュメント置き場です。READMEより長い説明や、チーム向けの運用手順をまとめるのに向いています。

Wikiに向いている内容

• 開発環境のセットアップ
• アーキテクチャメモ
• 運用手順
• リリース手順
• よくある質問

READMEは入口、Wikiは詳しい手順という役割にすると整理しやすくなります。

最初に作るページ

まずはHomeページを作り、重要なページへのリンクを置きます。

# Project Wiki

- Setup
- Development Workflow
- Release Guide
- Troubleshooting

今日のゴール

Wikiはチームの作業知識を残す場所です。READMEに詰め込みすぎず、長く使う手順はWikiへ分けましょう。