playbooks

home / skills / a5c-ai / babysitter / error-code-catalog

error-code-catalog skill

/plugins/babysitter/skills/babysit/process/specializations/sdk-platform-development/skills/error-code-catalog

This skill manages and documents SDK error codes, messages, and remediation guidance for consistent, actionable error handling across projects.

npx playbooks add skill a5c-ai/babysitter --skill error-code-catalog

Review the files below or copy the command above to add this skill to your agents.

Files (2)
SKILL.md
2.0 KB
---
name: error-code-catalog
description: Manage and document SDK error codes and messages
allowed-tools:
  - Read
  - Write
  - Edit
  - Glob
  - Grep
  - Bash
---

# Error Code Catalog Skill

## Overview

This skill manages a comprehensive catalog of SDK error codes, messages, and documentation, ensuring consistent, helpful error handling across all SDK operations.

## Capabilities

- Define error code taxonomy with categories
- Generate error documentation automatically
- Validate error message quality and actionability
- Support error localization (i18n)
- Map HTTP status codes to SDK errors
- Generate error handling code from catalog
- Track error frequency and patterns
- Create troubleshooting guides per error

## Target Processes

- Error Handling and Debugging Support
- API Design Specification
- API Documentation System

## Integration Points

- Error tracking systems (Sentry, Bugsnag)
- i18n frameworks for localization
- Documentation generators
- SDK code generation
- Analytics platforms

## Input Requirements

- Error categorization requirements
- Message style guidelines
- Localization requirements
- HTTP mapping rules
- Troubleshooting depth

## Output Artifacts

- Error code catalog (JSON/YAML)
- Error documentation pages
- SDK error classes/types
- Localization resource files
- Troubleshooting guides
- Error mapping tables

## Usage Example

```yaml
skill:
  name: error-code-catalog
  context:
    catalogFile: ./errors/catalog.yaml
    errorFormat:
      codePrefix: "SDK"
      codeLength: 4
      pattern: "SDK-{category}-{number}"
    categories:
      - auth
      - validation
      - network
      - rate-limit
      - server
    localization:
      enabled: true
      locales: ["en", "es", "ja", "de"]
    includeRemediation: true
```

## Best Practices

1. Use meaningful error code prefixes
2. Include remediation steps in all errors
3. Categorize errors logically
4. Keep error messages actionable
5. Support localization from the start
6. Link errors to documentation

Overview

This skill manages a comprehensive catalog of SDK error codes, messages, and documentation to ensure consistent, actionable error handling across SDKs. It produces machine-readable catalogs and human-facing documentation that developers and support teams can use to diagnose and remediate failures. The goal is predictable error taxonomy, improved observability, and faster debugging workflows.

How this skill works

The skill ingests error categorization rules, message style guidelines, HTTP mapping rules, and localization requirements to generate a structured catalog (JSON/YAML). It validates message quality and actionability, maps HTTP statuses to SDK errors, and can emit SDK error classes, localization resource files, and troubleshooting guides. It integrates with error tracking and analytics to track frequency and surface patterns for catalog updates.

When to use it

  • When designing or standardizing SDK error codes and message formats across services.
  • When you need automated generation of error docs, SDK error classes, or localization resources.
  • When mapping HTTP status codes to internal SDK error taxonomy for consistent handling.
  • When creating troubleshooting guides and remediation steps for recurring errors.
  • When integrating error catalogs with monitoring or analytics to prioritize fixes.

Best practices

  • Use meaningful, consistent error code prefixes and a predictable pattern (e.g., SDK-{category}-{number}).
  • Include concise remediation steps in every error message to guide fast recovery.
  • Categorize errors logically (auth, validation, network, rate-limit, server) to aid routing and metrics.
  • Design messages for actionability and test readability across locales.
  • Enable localization from the start and produce resource files for each supported locale.
  • Link each error to a documentation page or troubleshooting guide for deeper context.

Example use cases

  • Generate a catalog.yaml and localized resource files for SDK releases to ensure consistent error behavior.
  • Create SDK-specific error classes and mapping tables from the catalog for client libraries.
  • Produce developer-facing documentation pages and troubleshooting guides for common errors.
  • Validate error message quality and automatically flag messages lacking remediation steps.
  • Feed error frequency data from Sentry or Bugsnag into the catalog to prioritize fixes.

FAQ

Can this skill produce localized error messages?

Yes. It supports i18n, generates localization resource files for configured locales, and validates message translations for consistency.

How does it integrate with error tracking systems?

It exports catalog identifiers and mapping tables that you can attach to events in tracking systems (Sentry, Bugsnag), enabling frequency tracking and automated linking to documentation.