界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
效率与协作 · SKILL.md

speak-prod-checklist

speak-prod-checklist

【效率与协作】Production readiness checklist for Speak language learning integrations: auth, audio pipeline, monitoring, and compliance. Use when implementing prod checklist features, or troubleshooting Speak language learning integration issues. Trigger with phrases like "speak prod checklist", "speak prod checklist".

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: speak-prod-checklist description: 'Production readiness checklist for Speak language learning integrations: auth, audio pipeline, monitoring, and compliance.

Use when implementing prod checklist features,

or troubleshooting Speak language learning integration issues.

Trigger with phrases like "speak prod checklist", "speak prod checklist".

' allowed-tools: Read, Write, Edit, Bash(npm:), Bash(curl:), Grep version: 1.14.0 license: MIT author: Jeremy Longshore jeremy@intentsolutions.io tags:

  • saas
  • speak
  • api compatibility: Designed for Claude Code

Speak Production Checklist

Overview

Production readiness checklist for Speak language learning integrations: auth, audio pipeline, monitoring, and compliance.

Prerequisites

  • Completed speak-install-auth setup
  • Valid API credentials configured
  • ffmpeg installed for audio processing

Instructions

Authentication

  • API keys stored in secrets manager
  • Key rotation schedule established (90 days)
  • Separate keys for dev/staging/production
  • Error handling for expired keys

Audio Pipeline

  • Audio preprocessor converts to WAV 16kHz mono
  • File size validation (< 25MB)
  • Duration validation (0.5s - 60s)
  • Background noise detection/warning
  • Fallback for unsupported audio formats

Rate Limiting & Performance

  • Rate-limited client wrapper implemented
  • Retry logic with exponential backoff on 429
  • Request queue for batch assessments
  • Response caching where appropriate

Monitoring & Alerting

  • API response time tracking
  • Error rate monitoring (target < 1%)
  • Rate limit hit tracking
  • Assessment score distribution monitoring
  • Session completion rate tracking

Compliance

  • Student data privacy policy documented
  • Audio data retention policy implemented
  • COPPA compliance verified (if applicable)
  • FERPA compliance verified (if educational)
  • GDPR data processing agreement (if EU users)

Verification Script

#!/bin/bash
set -euo pipefail
echo "Speak Production Readiness"
curl -sf -H "Authorization: Bearer $SPEAK_API_KEY" \
  https://api.speak.com/v1/health | jq '.status'
echo "  Auth: PASS"
ffmpeg -version > /dev/null 2>&1 && echo "  ffmpeg: PASS" || echo "  ffmpeg: FAIL"
echo "Checks complete."

Output

  • Checklist implementation complete
  • Speak API integration verified
  • Production-ready patterns applied

Error Handling

ErrorCauseSolution
401 UnauthorizedInvalid API keyVerify SPEAK_API_KEY environment variable
429 Rate LimitedToo many requestsWait Retry-After seconds, use backoff
Audio format errorWrong codec/sample rateConvert to WAV 16kHz mono with ffmpeg
Session expiredTimeout after 30 minStart a new conversation session

Resources

Next Steps

See speak-prod-checklist for production readiness.

Examples

Basic: Apply prod checklist with default configuration for a standard Speak integration.

Advanced: Customize for production with error recovery, monitoring, and team-specific requirements.

我的收藏