YAMLを使い始めようとしているが「どうやってファイルを作ればいいの？」と迷っている方も多いでしょう。
本記事では、YAMLファイルの作り方・基本手順・拡張子の選び方・frontmatterの書き方・設定ファイルとしての活用まで、初心者にもわかりやすく解説していきます。
実際の手順をステップごとに説明しますので、ぜひ最後までご覧ください。
YAMLファイルの作り方：基本手順
それではまず、YAMLファイルの基本的な作り方と手順について解説していきます。
YAMLファイルの作り方は非常に簡単で、テキストエディタで新規ファイルを作成し、.yaml または .yml という拡張子で保存するだけです。
ステップ1：テキストエディタを準備する
YAMLファイルを作成するには、テキストエディタが必要です。
推奨エディタはVisual Studio Code（VSCode）で、無料で使えて YAML サポートが充実しています。
VSCodeに「YAML by Red Hat」拡張機能を追加することで、シンタックスハイライト・インデント補完・バリデーションが使えます。
メモ帳（Notepad）でも作成できますが、インデントミスに気づきにくいためYAML対応エディタの使用を強く推奨します。
ステップ2：ファイルを作成して拡張子を付ける
新規ファイルを作成し「設定名.yaml」または「設定名.yml」という名前で保存します。
.yaml はYAML公式推奨の拡張子で、.yml は短縮形です。
使用するツールやフレームワークが特定の拡張子を要求する場合はそれに従い、そうでなければ .yaml を使うとよいでしょう。
ファイルの文字コードはUTF-8（BOMなし）を使うことが標準です。
ステップ3：YAMLの内容を書く
ファイルを開き、YAML形式でデータを記述します。
【シンプルな設定ファイルの例（config.yaml）】
# アプリケーション設定
app:
name: MyApp
version: “1.0.0”
debug: false
database:
host: localhost
port: 5432
name: mydb
server:
port: 8080
workers: 4
コメント・マッピング・スカラーを組み合わせた典型的な設定ファイルの例です。
ステップ4：バリデーション（検証）を行う
ファイルを作成したら、YAMLの構文が正しいかバリデーションを行います。
オンラインのYAMLバリデーター（yaml-online-parser.appspot.com など）にペーストして確認するのが手軽です。
コマンドラインでは python3 -c “import yaml; yaml.safe_load(open(‘config.yaml’))” でエラーがないか確認できます。
作成後は必ずバリデーションを行い、インデントミスや書式エラーがないことを確認しましょう。
front matter（フロントマター）YAMLの作り方
続いては、静的サイトジェネレーターでよく使われる「front matter」形式のYAMLファイルの作り方を確認していきます。
front matterとは何か
front matterとは、マークダウンファイルの先頭に「—」で囲んだYAMLブロックを置いてメタデータを記述する形式です。
【front matterの例（記事ファイル）】
—
title: “YAMLファイルの作り方”
date: 2024-01-15
author: Tanaka
tags:
– yaml
– tutorial
draft: false
—
（以降にマークダウン本文が続く）
Jekyll・Hugo・Gatsby・Eleventy などの静的サイトジェネレーターではfront matter が標準的なメタデータ記法として使われています。
front matterファイルの作り方手順
front matter ファイルの作り方は次のとおりです。
拡張子は .md（マークダウン）を使い、ファイルの先頭に「—」を書きます。
YAMLのメタデータを記述し、再び「—」で閉じます。
その後にマークダウン本文を書きます。
front matterのYAMLブロックの書き方は通常のYAMLと同じルールに従います。
プロンプト・AI用のYAMLファイル
近年は ChatGPT・Claude などのAIのシステムプロンプトや設定をYAML形式で管理する活用例も増えています。
YAMLの構造化された書き方で、プロンプトの構成要素（role・instructions・examples など）を整理することでプロンプトの管理・バージョン管理がしやすくなります。
設定ファイルとしてのYAML活用シーン
続いては、YAMLファイルが実際に使われる主要な設定ファイルのシーンを確認していきます。
Docker Composeファイルの作り方
Docker Composeのサービス定義は「docker-compose.yml」というYAMLファイルで行います。
【docker-compose.ymlの基本例】
version: ‘3’
services:
web:
image: nginx:latest
ports:
– “80:80”
volumes:
– ./html:/usr/share/nginx/html
docker-compose.yml ファイルを作成し「docker compose up」コマンドを実行することで、定義したサービスが起動します。
GitHub ActionsのワークフローYAMLの作り方
GitHub Actionsのワークフローは「.github/workflows/」ディレクトリに .yml ファイルを作成して定義します。
プッシュ時に自動テストを実行する基本的なワークフローファイルは数十行のYAMLで定義できます。
フォルダの作成とYAMLファイルの配置だけでCI/CDパイプラインが有効になります。
KubernetesのマニフェストYAMLの作り方
Kubernetesでは Pod・Service・Deployment などのリソースをYAMLマニフェストで定義します。
kubectl apply -f deployment.yaml コマンドでYAMLファイルを適用することでリソースが作成されます。
Kubernetesの公式ドキュメントには各リソースの YAML テンプレートが提供されているため、テンプレートをベースに必要な部分を修正する方法が効率的です。
YAMLファイル作成時のよくあるミスと対処法
続いては、YAMLファイルを作成する際によく起きるミスと対処法を確認していきます。
タブ文字を使ってしまう
インデントにタブ文字を使うと「found character ‘\t’ that cannot start any token」のようなエラーが発生します。
エディタの設定で「タブをスペースに変換」を有効にすることでこのミスを防げます。
VSCodeでは「Editor: Insert Spaces」をオンにすると、Tab キーを押してもスペースが挿入されます。
コロンの後にスペースを忘れる
「key:value」（スペースなし）は文字列として扱われ、マッピングと認識されません。
「key: value」（コロン+スペース）が正しい記法です。
バリデーションエラーの対処
エラーが発生した場合、エラーメッセージの「line（行）」「column（列）」を確認して問題箇所を特定します。
VSCodeのYAML拡張機能はリアルタイムにエラーを表示してくれるため、作成しながら問題を発見できます。
まとめ
本記事では、YAMLファイルの作り方・基本手順・拡張子の選び方・front matterの書き方・設定ファイルとしての活用シーン・よくあるミスまで詳しく解説しました。
YAMLファイルはテキストエディタで .yaml/.yml 拡張子のファイルを作るだけで始められます。
YAML対応エディタの使用・バリデーションの実施・インデントのルールを守ることが正確なファイル作成のポイントです。
YAMLファイルの正しい作り方をマスターすることで、Docker・Kubernetes・CI/CDなどの設定管理を効率的に行えるようになります。
ぜひ本記事の手順に沿って、最初のYAMLファイルを作ってみてください。
