⚡

项目指南技能（示例）Skill cc-skill-project-guidelines-example

这个技能是一个软件开发项目指南模板，提供完整的项目结构和最佳实践指导，帮助团队快速启动和实施开发工作。它涵盖了架构设计、文件组织、代码规范、测试策略和部署流程，特别适合全栈开发项目，并结合AI集成如Claude API。关键词：软件开发、项目指南、架构设计、代码规范、测试部署、全栈开发、AI集成、最佳实践。

架构设计 0 次安装 0 次浏览 更新于 3/21/2026

name: cc-skill-project-guidelines-example description: 项目指南技能（示例） author: affaan-m version: “1.0”

项目指南技能（示例）

这是一个项目特定技能的示例。请将其用作您自己项目的模板。

基于真实生产应用：Zenith - AI驱动的客户发现平台。

何时使用

在针对特定项目工作时参考此技能。项目技能包含：

  • 架构概述
  • 文件结构
  • 代码模式
  • 测试要求
  • 部署工作流

架构概述

技术栈：

  • 前端：Next.js 15（应用路由）、TypeScript、React
  • 后端：FastAPI（Python）、Pydantic 模型
  • 数据库：Supabase（PostgreSQL）
  • 人工智能：Claude API 包含工具调用和结构化输出
  • 部署：Google Cloud Run
  • 测试：Playwright（端到端测试）、pytest（后端）、React Testing Library

服务：

┌─────────────────────────────────────────────────────────────┐
│                         前端                                 │
│  Next.js 15 + TypeScript + TailwindCSS                     │
│  部署：Vercel / Cloud Run                                   │
└─────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────┐
│                         后端                                 │
│  FastAPI + Python 3.11 + Pydantic                          │
│  部署：Cloud Run                                            │
└─────────────────────────────────────────────────────────────┘
                              │
              ┌───────────────┼───────────────┐
              ▼               ▼               ▼
        ┌──────────┐   ┌──────────┐   ┌──────────┐
        │ Supabase │   │  Claude  │   │  Redis   │
        │ 数据库   │   │   API    │   │  缓存    │
        └──────────┘   └──────────┘   └──────────┘

文件结构

项目/
├── 前端/
│   └── src/
│       ├── app/              # Next.js 应用路由页面
│       │   ├── api/          # API 路由
│       │   ├── (auth)/       # 身份验证保护的路由
│       │   └── workspace/    # 主应用工作区
│       ├── components/       # React 组件
│       │   ├── ui/           # 基础 UI 组件
│       │   ├── forms/        # 表单组件
│       │   └── layouts/      # 布局组件
│       ├── hooks/            # 自定义 React 钩子
│       ├── lib/              # 工具函数
│       ├── types/            # TypeScript 定义
│       └── config/           # 配置
│
├── 后端/
│   ├── routers/              # FastAPI 路由处理器
│   ├── models.py             # Pydantic 模型
│   ├── main.py               # FastAPI 应用入口
│   ├── auth_system.py        # 身份验证
│   ├── database.py           # 数据库操作
│   ├── services/             # 业务逻辑
│   └── tests/                # pytest 测试
│
├── 部署/                   # 部署配置
├── 文档/                     # 文档
└── 脚本/                  # 实用脚本

代码模式

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 集成（结构化输出）

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": "提供结构化分析",
            "input_schema": AnalysisResult.model_json_schema()
        }],
        tool_choice={"type": "tool", "name": "provide_analysis"}
    )

    # 提取工具使用结果
    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）

# 运行所有测试
poetry run pytest tests/

# 运行带覆盖率
poetry run pytest tests/ --cov=. --cov-report=html

# 运行特定测试文件
poetry run pytest tests/test_auth.py -v

测试结构：

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"

前端（React Testing Library）

# 运行测试
npm run test

# 运行带覆盖率
npm run test -- --coverage

# 运行端到端测试
npm run test:e2e

测试结构：

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

describe('WorkspacePanel', () => {
  it('正确渲染工作区', () => {
    render(<WorkspacePanel />)
    expect(screen.getByRole('main')).toBeInTheDocument()
  })

  it('处理会话创建', async () => {
    render(<WorkspacePanel />)
    fireEvent.click(screen.getByText('New Session'))
    expect(await screen.findByText('Session created')).toBeInTheDocument()
  })
})

部署工作流

预部署检查清单

  • [ ] 所有本地测试通过
  • [ ] npm run build 成功（前端）
  • [ ] poetry run pytest 通过（后端）
  • [ ] 无硬编码密钥
  • [ ] 环境变量已文档化
  • [ ] 数据库迁移准备就绪

部署命令

# 构建和部署前端
cd frontend && npm run build
gcloud run deploy frontend --source .

# 构建和部署后端
cd backend
gcloud run deploy backend --source .

环境变量

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

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

关键规则

  1. 代码、注释或文档中不使用表情符号
  2. 不可变性 - 永不修改对象或数组
  3. 测试驱动开发 - 先写测试后实现
  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/ - 测试驱动开发方法论