api-ergonomics

What problem does it solve?

This Skill helps developers write clean, intuitive APIs that are easy to understand and use, thus improving the user experience and reducing cognitive load for API consumers.

Core Features & Use Cases

• API Clarity Checks: Assesses clarity, misuse resistance, error surface size, and boilerplate ratio in module signatures and call sites.
• Caller-Perspective Comments: Encourages providing example callsites for each module, improving discoverability and reducing onboarding time.
• Ergonomic Design Recommendations: Offers best practices for API design such as progressive disclosure, cohesive modules, and effective error handling.
• Anti-Vocab Guidance: Helps identify common anti-patterns like 'stringly-typed' and 'primitive obsession' in API design.
• Error Shape Standards: Defines guidelines for error handling that allow calleres to effectively handle errors and operators to debug issues.

Quick Start

To ensure the API of a new module 'Checkout' adheres to ergonomics guidelines, run the skill with 'api-ergonomics Checkout' and follow the reviewer steps.