StackShelf
Markdown 第1回

Markdownとは?技術文書を書く理由と全体像

MarkdownはREADME・設計書・ブログで使われる軽量マークアップ言語です。WordやHTMLとの違い、技術ドキュメントで選ばれる理由を、具体例と失敗例つきで解説します。

6分で読める
Markdown技術ドキュメントREADMEGitHub初心者

結論:Markdownは「書きやすく、読みやすく、共有しやすい」文書形式

Markdown(マークダウン)は、見出しやリスト、コードなどを記号だけで表現する軽量マークアップ言語です。GitHubのREADME、社内Wiki、ブログ、API仕様書など、エンジニアが日常的に触れる文書の多くがMarkdown(またはそれに近い形式)で書かれています。Wordのように装飾パネルを触るのではなく、テキストエディタに # 見出し のように打ち込むだけで構造化できるのが最大の利点です。

日本語で体系的に学べる教材はまだ少なく、「記号の意味がわからない」「プレビューと表示が違う」といったつまずきが多いテーマです。この講座では、実務でよくある失敗例を交えながら、8ステップで読める・書ける・共有できるレベルまで進めます。

Markdownが生まれた背景

2004年頃、ジョン・グルーバー(John Gruber)とアーロン・スワーツ(Aaron Swartz)によって設計されました。目的はメールや掲示板で読みやすいプレーンテキストを、最小限の記法で構造化することでした。当時から「HTMLを直接書くほどではないが、装飾のない文章だけでは伝わらない」というニーズがあり、今もその思想は変わっていません。

現在では、GitHub・Notion・Qiita・Zenn・Slack・Discordなど、多くのサービスがMarkdown(または独自拡張を加えた派生)を採用しています。ツールごとに細部の解釈が異なる点には注意が必要ですが、基本記法は共通しているため、一度覚えれば転用しやすいスキルです。

Word・HTML・Markdownの使い分け

「どれを使えばいいのか」は初学者がよく検索する疑問です。結論から言うと、用途で選び分けます。

  • Word:契約書・提出用レポートなど、厳密なレイアウトと承認フローが必要な文書
  • HTML:Webページとして配信し、CSSやJavaScriptと組み合わせる本番サイト
  • Markdown:リポジトリ内の説明、開発者向け手順書、変更履歴と一緒に管理したい文書

技術プロジェクトでは、ソースコードと同じGitリポジトリに README.md を置き、プルリクエストでレビューする文化が一般的です。Wordファイルをメールで送り合うより、差分(diff)が見えるMarkdownの方がチーム開発と相性が良いのです。

よくある失敗:「全部Wordで書いてから貼る」

社内手順をWordで作り、Wikiにコピペすると、フォントや表の書式が崩れ、リンクやコードが壊れることがよくあります。最初から .md ファイルとして書き、リポジトリやWikiに置く方が、長期的な更新コストは下がります。

Markdownファイルの見た目

拡張子は通常 .md または .markdown です。中身はほぼプレーンテキストなので、メモ帳でも開けます。次の例は、これから学ぶ記法の「予告編」です。

# プロジェクト名

このリポジトリは**サンプルAPI**のクライアントです。

## 必要条件

- Node.js 18 以上
- npm 9 以上

## インストール

```bash
npm install
npm run build
```

左側は人間が編集しやすいテキスト、右側(プレビュー)では見出しや太字、コードブロックに変換されます。変換の仕組みは「パーサー」と呼ばれるプログラムが担い、GitHub上では自動的にHTML表示に変換されます。

技術ドキュメントMarkdownが選ばれる理由

実務の現場でMarkdownが好まれる理由は、次の4点に集約できます。

  1. バージョン管理と相性が良い:Gitで差分が読みやすく、誰がいつ何を直したか追える
  2. コードとの同居:同じフォルダに src/docs/ を置ける
  3. 執筆の速さ:装飾より内容に集中できる
  4. ツールエコシステム:Lint、静的サイト生成(MkDocs、Docusaurus)、CIでの自動チェックがしやすい

新卒研修や副業開発でも、「READMEが読みにくい」プロジェクトは信頼を損ないがちです。コードの品質と同様に、入口となる説明文の品質も採用・コントリビューションの判断材料になります。

Flavored Markdown(方言)に注意

「CommonMark」「GitHub Flavored Markdown(GFM)」「独自Wiki記法」など、方言と呼べるバリエーションがあります。例えば表の書き方、チェックボックス、数式の有無はサービス依存です。基本記法(見出し・リスト・強調・リンク・コード)を押さえれば、どの環境でも8割は動きます。プレビューが想定と違うときは、まずそのサービスのドキュメントを確認する習慣をつけましょう。

誰がMarkdownを使っているか

フロントエンド・バックエンド・インフラ・データ分析など、職種を問わず「説明文をリポジトリやWikiに残す」場面でMarkdownが使われます。新卒の研修課題、副業のOSS、社内ツールの手順書まで、コードを書く人なら一度はREADMEを直す機会があります。英語の公式ドキュメントが多い分、日本語で「つまずきポイントまで書かれた」入門が少ないのも、この講座を用意した理由です。

よく検索される疑問への短答

  • Markdownは難しい? — 基本記法は20種類ほど。1日で触り始められます
  • Wordより劣る? — 印刷レイアウトではWordが有利。変更履歴とコード同居ではMarkdownが有利
  • 無料? — 仕様・ツールともに無料で使えるものがほとんどです
  • 就職に役立つ? — READMEや設計メモを読み書きできることは、実務・面接双方で評価されやすいです

この講座で身につくこと

全8回で、基本記法からREADMEの実践、ドキュメント構成、エディタ・Lint、最終的なプロジェクトREADME作成までを扱います。プログラミング経験がなくても、テキストを書いたことがあれば十分です。GitやLinuxの基礎があると、実践編がスムーズですが、必須ではありません。

学習のコツは「読むだけ」ではなく、毎回1つずつ .md ファイルを手元で作り、プレビューで確認することです。記号を1つ変えるたびに表示が変わるため、体験が早いです。第2回以降は、前回のファイルに追記していく形でも構いません。

まとめ

Markdownは、技術文書を速く・協力しやすく・長く保守しやすく書くための標準的な選択肢です。WordやHTMLを置き換えるものではなく、開発とドキュメントを同じワークフローに載せるための道具と捉えてください。次回から、見出し・段落・強調の基本記法に入ります。

まとめ

Markdownは記号で構造を表す軽量マークアップ言語で、READMEや設計書など技術文書の事実上の標準です。Wordは厳密なレイアウト向け、HTMLはWeb配信向け、MarkdownはGitで管理する説明文向けと使い分けます。サービスごとに方言があるため、基本を押さえたうえでプレビューで確認する習慣が大切です。手を動かしながら8回で実務レベルまで進めましょう。

次にやること

手元に sample.md を作り、# タイトル と一段落だけ書いてVS Codeのプレビューで表示を確認してください。記号1つで見た目が変わる体験が、学習の土台になります。

よくある質問

Markdownはプログラミング言語ですか?

いいえ。実行可能なプログラムではなく、文書の構造を記述するマークアップ言語です。ただし、コードブロック内にプログラムを貼ることはでき、技術文書との相性が良い形式です。

MarkdownとHTMLはどちらを先に学ぶべきですか?

READMEや社内ドキュメントを書く目的ならMarkdownを先に学ぶのが効率的です。Webページ制作やフロントエンド開発が目的なら、並行してHTML/CSSを学ぶとよいでしょう。

.md ファイルはどのアプリで開けますか?

VS Code、Typora、メモ帳など任意のテキストエディタで開けます。プレビュー付きで見るならVS Codeの「Markdownプレビュー」が無料で手軽です。

日本語で書いても問題ありませんか?

問題ありません。UTF-8で保存すれば、見出し・本文・コードコメントすべて日本語で記述できます。文字化けする場合はファイルの文字コード設定を確認してください。

Markdownを覚えるのにどのくらいかかりますか?

基本記法(見出し・リスト・強調・リンク・コード)は数時間の練習で使い始められます。READMEを1本作り切る経験を1回積めば、日常のドキュメント執筆には十分なレベルに達します。

次に読むべき記事

同カテゴリ「Markdown」の記事

学習ルート

体系的に学びたい方はこちらから。

インフラ・ドキュメントコース →

あわせて読みたい