プロジェクトガイドラインスキル(例)
これはプロジェクト固有スキルの例です。自分のプロジェクト用テンプレートとして使用してください。
実際のプロダクションアプリに基づく: Zenith - AI 搭載のカスタマー発見プラットフォーム。
使うタイミング
このスキルは対象プロジェクトで作業する際に参照する。プロジェクトスキルには以下が含まれる:
- •アーキテクチャ概要
- •ファイル構造
- •コードパターン
- •テスト要件
- •デプロイフロー
アーキテクチャ概要
技術スタック:
- •フロントエンド: Next.js 15(App Router)、TypeScript、React
- •バックエンド: FastAPI(Python)、Pydantic モデル
- •DB: Supabase(PostgreSQL)
- •AI: Claude API(ツール呼び出し + 構造化出力)
- •デプロイ: Google Cloud Run
- •テスト: Playwright(E2E)、pytest(backend)、React Testing Library
サービス:
text
┌─────────────────────────────────────────────────────────────┐
│ 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 │
└──────────┘ └──────────┘ └──────────┘
ファイル構造
text
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)
python
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)
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 連携(構造化出力)
python
from anthropic import Anthropic
from pydantic import BaseModel
class AnalysisResult(BaseModel):
summary: str
key_points: list[str]
confidence: float
async def analyze_with_claude(content: str) -> AnalysisResult:
client = Anthropic()
response = client.messages.create(
model="claude-sonnet-4-5-20250514",
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)
typescript
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 };
}
テスト要件
Backend(pytest)
bash
# 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
テスト構造:
python
import pytest
from httpx import AsyncClient
from main import app
@pytest.fixture
async def client():
async with AsyncClient(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"
Frontend(React Testing Library)
bash
# Run tests npm run test # Run with coverage npm run test -- --coverage # Run E2E tests npm run test:e2e
テスト構造:
typescript
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成功(frontend) - •
poetry run pytest成功(backend) - • ハードコードされたシークレットがない
- • 環境変数がドキュメント化されている
- • DB マイグレーション準備完了
デプロイコマンド
bash
# フロントエンドのビルド&デプロイ cd frontend && npm run build gcloud run deploy frontend --source . # バックエンドのビルド&デプロイ cd backend gcloud run deploy backend --source .
環境変数
bash
# 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...
重要ルール
- •コード/コメント/ドキュメントで 絵文字禁止
- •イミュータビリティ - オブジェクト/配列のミューテーション禁止
- •TDD - 実装前にテストを書く
- •80% カバレッジ 最低ライン
- •小さなファイル多数 - 200〜400 行が目安、最大 800 行
- •本番で console.log 禁止
- •try/catch による適切なエラーハンドリング
- •Pydantic/Zod による入力バリデーション
関連スキル
- •
coding-standards.md- 汎用コーディングベストプラクティス - •
backend-patterns.md- API と DB パターン - •
frontend-patterns.md- React / Next.js パターン - •
tdd-workflow/- テスト駆動開発