cc-skill-project-guidelines-example

プロジェクトガイドラインスキル（例）

これはプロジェクト固有のスキルの例です。独自のプロジェクト向けのテンプレートとしてご利用ください。

実際の本番アプリケーションを基にしています：Zenith - AI を活用した顧客発見プラットフォーム。

---

使用するタイミング

このスキルが設計されている特定のプロジェクトで作業する際に参照してください。プロジェクトスキルには、以下が含まれます。

• アーキテクチャの概要
• ファイル構成
• コードパターン
• テスト要件
• デプロイのワークフロー

---

これは参考用のプロジェクトテンプレートであり、現在のリポジトリのアーキテクチャやポリシーを示すものではありません。コマンドや依存関係を確認し、ローカルの規約を維持したうえで、適用可能なデプロイ権限を得てから適用してください。(auth) のようなルートグループ名だけでは認証は強制されません。SDK／テストのスニペットを使用するには、プロジェクトのフィクスチャ、ライフサイクルのセットアップ、サポート対象のパッケージ／モデルバージョンが必要です。公開 Supabase キーを使用する場合も、RLS を適切にテストする必要があり、サービスロールキーはサーバー側に限定してください。

アーキテクチャの概要

技術スタック：

• フロントエンド：Next.js 15（App Router）、TypeScript、React
• バックエンド：FastAPI（Python）、Pydantic モデル
• データベース：Supabase（PostgreSQL）
• AI：ツール呼び出しと構造化出力を使用する Claude API
• デプロイ：Google Cloud Run
• テスト：Playwright（E2E）、pytest（バックエンド）、React Testing Library

サービス：

┌─────────────────────────────────────────────────────────────┐
│                         Frontend                            │
│  Next.js 15 + TypeScript + TailwindCSS                     │
│  Deployed: Vercel / Cloud Run                              │
└─────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────┐
│                         Backend                             │
│  FastAPI + Python 3.11 + Pydantic                          │
│  Deployed: Cloud Run                                       │
└─────────────────────────────────────────────────────────────┘
                              │
              ┌───────────────┼───────────────┐
              ▼               ▼               ▼
        ┌──────────┐   ┌──────────┐   ┌──────────┐
        │ Supabase │   │  Claude  │   │  Redis   │
        │ Database │   │   API    │   │  Cache   │
        └──────────┘   └──────────┘   └──────────┘

---

ファイル構成

project/
├── frontend/
│   └── src/
│       ├── app/              # Next.js app router pages
│       │   ├── api/          # API routes
│       │   ├── (auth)/       # Auth-protected routes
│       │   └── workspace/    # Main app workspace
│       ├── components/       # React components
│       │   ├── ui/           # Base UI components
│       │   ├── forms/        # Form components
│       │   └── layouts/      # Layout components
│       ├── hooks/            # Custom React hooks
│       ├── lib/              # Utilities
│       ├── types/            # TypeScript definitions
│       └── config/           # Configuration
│
├── backend/
│   ├── routers/              # FastAPI route handlers
│   ├── models.py             # Pydantic models
│   ├── main.py               # FastAPI app entry
│   ├── auth_system.py        # Authentication
│   ├── database.py           # Database operations
│   ├── services/             # Business logic
│   └── tests/                # pytest tests
│
├── deploy/                   # Deployment configs
├── docs/                     # Documentation
└── scripts/                  # Utility scripts

---

コードパターン

API レスポンス形式（FastAPI）

from pydantic import BaseModel
from typing import Generic, TypeVar, Optional

T = TypeVar('T')

class ApiResponse(BaseModel, Generic[T]):
    success: bool
    data: Optional[T] = None
    error: Optional[str] = None

    @classmethod
    def ok(cls, data: T) -> "ApiResponse[T]":
        return cls(success=True, data=data)

    @classmethod
    def fail(cls, error: str) -> "ApiResponse[T]":
        return cls(success=False, error=error)

フロントエンドの API 呼び出し（TypeScript）

interface ApiResponse<T> {
  success: boolean
  data?: T
  error?: string
}

async function fetchApi<T>(
  endpoint: string,
  options?: RequestInit
): Promise<ApiResponse<T>> {
  try {
    const response = await fetch(`/api${endpoint}`, {
      ...options,
      headers: {
        'Content-Type': 'application/json',
        ...options?.headers,
      },
    })

    if (!response.ok) {
      return { success: false, error: `HTTP ${response.status}` }
    }

    return await response.json()
  } catch (error) {
    return { success: false, error: String(error) }
  }
}

Claude AI の統合（構造化出力）

import os
from anthropic import AsyncAnthropic
from pydantic import BaseModel

class AnalysisResult(BaseModel):
    summary: str
    key_points: list[str]
    confidence: float

async def analyze_with_claude(content: str) -> AnalysisResult:
    client = AsyncAnthropic()

    response = await client.messages.create(
        model=os.environ["ANTHROPIC_MODEL"]  # verified supported model ID,
        max_tokens=1024,
        messages=[{"role": "user", "content": content}],
        tools=[{
            "name": "provide_analysis",
            "description": "Provide structured analysis",
            "input_schema": AnalysisResult.model_json_schema()
        }],
        tool_choice={"type": "tool", "name": "provide_analysis"}
    )

    # Extract tool use result
    tool_use = next(
        block for block in response.content
        if block.type == "tool_use"
    )

    return AnalysisResult(**tool_use.input)

カスタムフック（React）

import { useState, useCallback } from 'react'

interface UseApiState<T> {
  data: T | null
  loading: boolean
  error: string | null
}

export function useApi<T>(
  fetchFn: () => Promise<ApiResponse<T>>
) {
  const [state, setState] = useState<UseApiState<T>>({
    data: null,
    loading: false,
    error: null,
  })

  const execute = useCallback(async () => {
    setState(prev => ({ ...prev, loading: true, error: null }))

    const result = await fetchFn()

    if (result.success) {
      setState({ data: result.data!, loading: false, error: null })
    } else {
      setState({ data: null, loading: false, error: result.error! })
    }
  }, [fetchFn])

  return { ...state, execute }
}

---

テスト要件

バックエンド（pytest）

# Run all tests
poetry run pytest tests/

# Run with coverage
poetry run pytest tests/ --cov=. --cov-report=html

# Run specific test file
poetry run pytest tests/test_auth.py -v

テスト構成：

import pytest
from httpx import ASGITransport, AsyncClient
import pytest_asyncio
from main import app

@pytest_asyncio.fixture
async def client():
    async with AsyncClient(transport=ASGITransport(app=app), base_url="http://test") as ac:
        yield ac

@pytest.mark.asyncio
async def test_health_check(client: AsyncClient):
    response = await client.get("/health")
    assert response.status_code == 200
    assert response.json()["status"] == "healthy"

フロントエンド（React Testing Library）

# Run tests
npm run test

# Run with coverage
npm run test -- --coverage

# Run E2E tests
npm run test:e2e

テスト構成：

import { render, screen, fireEvent } from '@testing-library/react'
import { WorkspacePanel } from './WorkspacePanel'

describe('WorkspacePanel', () => {
  it('renders workspace correctly', () => {
    render(<WorkspacePanel />)
    expect(screen.getByRole('main')).toBeInTheDocument()
  })

  it('handles session creation', async () => {
    render(<WorkspacePanel />)
    fireEvent.click(screen.getByText('New Session'))
    expect(await screen.findByText('Session created')).toBeInTheDocument()
  })
})

---

デプロイのワークフロー

デプロイ前のチェックリスト

• すべてのテストがローカルで成功する
• npm run build が成功する（フロントエンド）
• poetry run pytest が成功する（バックエンド）
• ハードコードされたシークレットがない
• 環境変数が文書化されている
• データベースのマイグレーションが準備できている

デプロイコマンド

# Build and deploy frontend
cd frontend && npm run build
gcloud run deploy frontend --source .

# Build and deploy backend
cd backend
gcloud run deploy backend --source .

環境変数

# Frontend (.env.local)
NEXT_PUBLIC_API_URL=https://api.example.com
NEXT_PUBLIC_SUPABASE_URL=https://xxx.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJ...

# Backend (.env)
DATABASE_URL=postgresql://...
ANTHROPIC_API_KEY=sk-ant-...
SUPABASE_URL=https://xxx.supabase.co
SUPABASE_KEY=eyJ...

---

重要なルール

1. コード、コメント、ドキュメントでは絵文字を使用しない
2. 不変性 - オブジェクトや配列を変更しない
3. TDD - 実装前にテストを書く
4. カバレッジは最低 80%
5. 小さなファイルを多数作成する - 通常は 200～400 行、最大 800 行
6. 本番コードでは console.log を使用しない
7. try/catch による適切なエラー処理
8. Pydantic／Zod による入力検証

---

関連スキル

• coding-standards.md - 一般的なコーディングのベストプラクティス
• backend-patterns.md - API とデータベースのパターン
• frontend-patterns.md - React と Next.js のパターン
• tdd-workflow/ - テスト駆動開発の手法

制限事項

• 上記の説明にある範囲とタスクが明確に一致する場合にのみ、このスキルを使用してください。
• 出力を、環境固有の検証、テスト、専門家によるレビューの代わりとして扱わないでください。
• 必要な入力、権限、安全上の境界、成功基準が不足している場合は、作業を止めて確認してください。