AGENTS.md

各エージェントはこのリポジトリで作業するときに必ずこのファイルを読むこと


目次

  1. プロジェクト概要
  2. ディレクトリ構造
  3. 記事ファイルの命名規則
  4. フロントマター
  5. カテゴリ
  6. タグ
  7. 文体・文章スタイル
  8. タイトルの作り方
  9. 構成パターン
  10. やってはいけないこと
  11. ローカル確認
  12. コミット規則

プロジェクト概要

Waka-DS.com ── ITコンサルタントによる技術ブログ。 Jekyll + jekyll-theme-yat で構築されたスタティックサイト。GitHub Pages でホストされている。

主なコンテンツ: Data Engineering・AI Agent 開発・SaaS 最適化など。


ディレクトリ構造

_posts/         記事ファイル(日本語・英語とも置く)
_includes/      Liquid テンプレートのパーツ
_layouts/       ページレイアウト
_sass/          スタイルシート
_template/      新規記事のテンプレート
_data/          サイトデータ(ナビなど)
assets/         画像・CSS・JS
en/             英語サイトのインデックス系ページ

記事ファイルの命名規則

_posts/YYYY-MM-DD-slug.md        日本語記事
_posts/YYYY-MM-DD-slug-en.md     英語記事(日本語と対になる場合)

フロントマター

日本語記事

---
layout: post
title: "タイトル"
subtitle: サブタイトル(省略可)
categories: 開発
tags: ["タグ1", "タグ2"]
lang: ja
ref: slug-name   # 日英対応させる場合のみ。英語版と同じ値にする
---

英語記事

---
layout: post
title: "Title"
subtitle: Subtitle (optional)
categories: Development
tags: ["tag1", "tag2"]
lang: en
ref: slug-name   # 日本語版と同じ値
---

フィールドの注意点


カテゴリ

カテゴリは以下のリストから選ぶ。リストにないものを使いたい場合は追加を提案すること(勝手に増やさない)。

日本語記事

カテゴリ 使いどころ
開発 技術的な実装・ツール・言語・サービス全般
AI開発 AI・LLM・エージェント開発に特化した内容
データエンジニアリング データパイプライン・分析基盤・DB設計など
インフラ クラウド・ホスティング・デプロイ・Docker など
ブログ ブログ自体に関するメタな記事

英語記事

Category 使いどころ
Development 開発 の英語版
AI Development AI開発 の英語版
Data Engineering データエンジニアリング の英語版
Infrastructure インフラ の英語版
Blog ブログ の英語版

タグ

既存記事で使われているタグ。新規タグを追加する場合は既存のものと重複・類似していないか確認すること。

日本語タグ

AI開発, AIエージェント, AIネイティブ開発, AIセーフティ, マルチエージェント, ハーネスエンジニアリング, コンテキスト管理, 自動化, 報酬ハッキング, アライメント, Python, Docker, PostgreSQL, LLM, データベース, バックエンド, 開発環境, コードフォーマッター, コーディングエージェント, ホスティング, フロントエンド, ドキュメント

英語タグ

Python, Docker, PostgreSQL, SQL, LLM, Claude, Claude Code, Codex, Codex CLI, opencode, agmsg, Supabase, Railway, Neon, Vercel, Netlify, Cloudflare, BaaS, PaaS, Backend, Frontend, OpenAPI, REST, API, Swagger, Next.js, CLI, OSS, GitHub Pages, Jekyll, AI, AI-Native Development, Code Formatter, Development Environment, Database, Ralph Loop, Black, Alembic, SQLAlchemy, JSONB


文体・文章スタイル

基本方針

避けるべきパターン(AIらしい文章の典型)

太字・強調の乱用

冒頭の大仰な宣言

「つまり」「すなわち」「換言すると」の多用

箇条書きへの過剰依存

平行構造の繰り返し

最後の「まとめ」的な一言

強調副詞の多用

「非常に」「まさに」「絶対に」「最も」など。使うなら記事全体で1〜2回まで。

文章のトーン

記事によって合うトーンが異なる。無理に統一しない。


タイトルの作り方

タイトルは記事の内容・価値・対象読者が伝わるように作る。以下のパターンを参考に。

パターン
ゴール+手段 “エージェントを長く自律動作させるためのコンテキスト設計”
問題+解消 “Claude と Codex のマルチエージェント引き継ぎ問題と解消パターン”
疑問形 “なぜフロントエンドに Vercel を選ぶのか”
対象者+ツール名 “AI コーディング向けの Python フォーマッター Black”
動詞句(何をするか) “OpenAPI で API の仕様とドキュメントを同期させる”
比較 “Supabase vs Railway vs Neon バックエンド選定 (2026年版)”

避けるパターン:


構成パターン

記事ごとに合う構成を選ぶ。毎回同じパターンにしない。

パターン A: 結論先行型

仕組みやツールの解説に向く。

導入(問題提起)
## 結論を先に
## 各セクション
## まとめ(表)
## 参考

パターン B: 調査ログ型

比較・選定・調べてみた系の記事に向く。Supabase vs Railway 記事がこの例。

導入(自分のユースケースや背景)
## 軸の整理 or 前提
## サービスA
## サービスB
## 比較・まとめ
## 参考

パターン C: 問題分解型

原因と対処を掘り下げる記事に向く。

導入(現象・問題)
## なぜ起きるか
## 構造の整理
## 対処パターン or 解決策
## まとめ

パターン D: 自由形式

上記に収まらない場合は無理に型に合わせない。読んで自然に流れる構成にする。


やってはいけないこと


ローカル確認

# Docker で起動(推奨)
docker compose up

# ブラウザで確認
# http://localhost:4000

コミット規則

コミットはユーザーが実行する。作業完了後に以下の形式で案を提示すること。

add: 新規記事を追加したとき
fix: 記事内容の修正
update: 既存記事のアップデート
refactor: テンプレートや構造の変更(記事内容は変えない)