api-review

# API Review Workflow ## Table of Contents 1. [Usage](#usage) 2. [Required Progress Tracking](#required-progress-tracking) 3. [Workflow](#workflow) ## Usage Use this skill to review public API changes, design new surfaces, audit consistency, and validate documentation completeness. Run it before any API release to confirm alignment with project guidelines. ## Required Progress Tracking 1. `api-review:surface-inventory` 2. `api-review:exemplar-research` 3. `api-review:consistency-audit` 4. `api-review:docs-governance` 5. `api-review:evidence-log` ## Workflow ### Step 1: Surface Inventory Catalog all public APIs by language. Record stability levels, feature flags, and versioning metadata. Use tools like `rg` to find public symbols (e.g., `pub` in Rust or non-underscored `def` in Python). Confirm the working tree state with `git status` before starting. ### Step 2: Exemplar Research Identify at least two high-quality API references for the relevant language, such as pandas, requests, or tokio. Document their patterns for namespacing, pagination, error handling, and structure to serve as a baseline for the audit. ### Step 3: Consistency Audit Compare the project's API against the identified exemplar patterns. Analyze naming conventions, parameter ordering, return types, and error semantics. Identify duplication, leaky abstractions, missing feature gates, and documentation gaps. ### Step 4: Documentation Governance Validate that documentation includes entry points, ...