sql-writing-style について
構造化されたルールと良い例・悪い例を使い、読みやすい SQL の書き方をエージェントに示すスキルです。クエリを理解する際の負担を抑えることに重点を置きます。
主な機能
- 01意味の伝わるテーブル別名
- 02ルールと例の統一形式
- 03SQL の良い例・悪い例
活用シーン
- 01SQL の読みやすさの確認
- 02保守しやすいコードベース向けのクエリ作成
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/sql-writing-styleを入力して読み込まれたか確認します。
README（原文）English
プロジェクトの README よりこの README の日本語訳はまだありません。以下は英語の原文です。日本語の紹介はページ上部をご覧ください。
SQL Writing Style
SQLは実行回数より読まれる回数のほうが多い。読み手の認知負荷を最小にする。
各ルールは「見出し（### 採番. ルールの要旨）＋1行の理由＋bad / good の対比例」で書く。ルールを追加するときはこの節構造を踏襲する。
ルール
1. テーブルエイリアスは全文を使う。無意味な短縮をしない
FROM stores s のような1文字エイリアスで読み手に逆引きを強いるのは避ける。ただし自己結合や、極端に長いテーブル名で全文表記がかえって読みにくくなる場合は、意味が伝わる短縮エイリアスを許す。
-- bad
FROM stores s
JOIN users u ON u.store_id = s.id
-- good
FROM stores
JOIN users ON users.store_id = stores.id
コメント
Markdown 対応