api-documenter
Use when a task needs consumer-facing API documentation generated from the real implementation, schema, and examples.
Works with
--- name: api-documenter description: Use when a task needs consumer-facing API documentation generated from the real implementation, schema, and examples. license: MIT --- ## Instructions Own API documentation engineering work as domain-specific reliability and decision-quality engineering, not checklist completion. Prioritize the smallest practical recommendation or change that improves safety, correctness, and operational clarity in this domain. Working mode: 1. Map the domain boundary and concrete workflow affected by the task. 2. Separate confirmed evidence from assumptions and domain-specific unknowns. 3. Implement or recommend the smallest coherent intervention with clear tradeoffs. 4. Validate one normal path, one failure path, and one integration edge. Focus on: - contract fidelity between docs and real implementation/schema behavior - endpoint-level request/response examples that reflect actual edge cases - authentication, authorization, and error-model clarity for consumers - versioning/deprecation communication and migration guidance quality - pagination, rate limit, and idempotency semantics in docs - operational notes for retries, webhooks, and eventual-consistency behavior - documentation structure that supports fast onboarding and safe integration Quality checks: - verify documented fields/status codes map to current code/schema truth - confirm examples include one success and one failure/edge scenario - check auth/error sections for ambiguous or unsafe consumer assumptions - ensure breaking-change notes and migration paths are explicit - call out endpoints requiring runtime validation for uncertain behavior Return: - exact domain boundary/workflow analyzed or changed - primary risk/defect and supporting evidence - smallest safe change/recommendation and key tradeoffs - validations performed and remaining environment-level checks - residual risk and prioritized next actions Do not invent undocumented API behavior or guarantees unless explicitly requested by the parent agent.
More Writing & Documentation skills
paper-context-resolver
lllllllama/rigorpilot-skills
Rigor Paper Context helper for README-first deep learning repo reproduction. Use only when the README and repository files leave a narrow reproduction-critical gap and the task is to resolve a specific paper detail such as dataset split, preprocessing, evaluation protocol, checkpoint mapping, or runtime assumption from primary paper sources while recording conflicts. Do not use for general paper summary, repo scanning, environment setup, command execution, title-only paper lookup, or replacing README guidance by default.
repo-intake-and-plan
lllllllama/rigorpilot-skills
Rigor Intake helper for README-first deep learning repo reproduction. Use when the task is specifically to scan a repository, read the README and common project files, extract documented commands, classify inference, evaluation, and training candidates, and return the smallest trustworthy reproduction plan to the main orchestrator. Do not use for environment setup, asset download, command execution, final reporting, paper lookup, or end-to-end orchestration.
minimal-run-and-audit
lllllllama/rigorpilot-skills
Rigor Run skill for README-first deep learning repo reproduction. Use when the task is specifically to capture or normalize evidence from the selected smoke test or documented inference or evaluation command and write standardized `repro_outputs/` files, including patch notes when repository files changed. Do not use for training execution, initial repo intake, generic environment setup, paper lookup, target selection, hidden scientific-meaning changes, or end-to-end orchestration by itself.
