diataxis:reference
Use when the user asks for API docs, CLI command reference, configuration reference, parameter tables, schema documentation, error code lists, or version compatibility matrices. Creates neutral, structured, scannable technical reference — factual description of the machinery for lookup during active work. Do not use for onboarding, task guides, or conceptual justification.
What this skill does
# Reference writer ## Purpose Write technical reference that describes the machinery accurately, neutrally, and in a predictable structure. Reference is for truth, certainty, and lookup while working. ## When to use Use this skill when the user asks for: - API docs - CLI command docs - configuration reference - parameter tables - schema docs - error code lists - version compatibility matrices Do not use this skill for onboarding, tasks, or conceptual justification. ## Core principles - describe and only describe - neutral, factual, and precise - structured around the thing being documented - complete enough for lookup - consistent in format and terminology - examples may illustrate, but must not turn into tutorials ## Reader need The reader asks: - What is this? - What are the valid inputs? - What does it return or affect? - What constraints, defaults, or limits apply? - What errors or warnings exist? ## Structure patterns Choose one consistent pattern per item type. ### API endpoint - Name - Purpose - Method / path - Authentication - Parameters - Request body - Response body - Errors - Examples - Notes / limits ### CLI command - Name - Synopsis - Arguments - Options - Defaults - Exit codes - Examples - Related commands ### Config key - Name - Type - Default - Required or optional - Allowed values - Effect - Constraints - Example ## Writing rules - avoid persuasion and opinion - avoid "best practice" unless clearly marked and linked elsewhere - avoid long narrative prose - use standard headings and repeated patterns - mirror the structure of the product where possible - make scanning easy ## Examples policy Examples are allowed when they clarify usage, but they must stay illustrative. Good: - one short request example - one short response example - one command example showing syntax Bad: - long walkthroughs - conceptual essays attached to every field - advice-heavy examples disguised as reference ## Inputs to gather - product surface being documented - canonical names and terminology - exact signatures, defaults, constraints, limits - warnings and error cases - version and compatibility notes - examples that reflect reality ## Output contract Produce reference that: - is structured consistently - is easy to scan - states facts cleanly - separates facts from advice - can be trusted during active work ## Anti-patterns to remove - recommendation language without a clear basis - tutorial prose - hidden defaults - vague types like "object" without schema details - missing constraints and edge cases - inconsistent naming across entries ## Final self-check Before returning, verify: - the document is neutral - the structure mirrors the product surface - repeated items use a repeated template - warnings and limits are explicit - examples illustrate rather than teach
Related in Backend & APIs
jfrog
IncludedInteract with the JFrog Platform via the JFrog CLI and REST/GraphQL APIs. Use this skill when the user wants to manage Artifactory repositories, upload or download artifacts, manage builds, configure permissions, manage users and groups, work with access tokens, configure JFrog CLI servers, search artifacts, manage properties, set up replication, manage JFrog Projects, run security audits or scans, look up CVE details, query exposures scan results from JFrog Advanced Security, manage release bundles and lifecycle operations, aggregate or export platform data, or perform any JFrog Platform administration task. Also use when the user mentions jf, jfrog, artifactory, xray, distribution, evidence, apptrust, onemodel, graphql, workers, mission control, curation, advanced security, exposures, or any JFrog product name.
cupynumeric-migration-readiness
IncludedPre-migration readiness assessor for porting NumPy to cuPyNumeric. Use BEFORE substantial porting work begins when the user asks whether code will scale on GPU, whether they should migrate to cuPyNumeric, which NumPy patterns transfer cleanly, what must be refactored before porting, or mentions pre-port assessment, scaling analysis, or refactor planning. Inspect the user's source code, look up NumPy usage, cross-reference the cuPyNumeric API support manifest, and distinguish distributed-scaling-friendly patterns from blockers such as unsupported APIs, scalar synchronization, host round-trips, Python/object-heavy control flow, shape/data-dependent branching, and in-place mutation hazards. Produce a verdict of READY, LIGHT REFACTOR, SIGNIFICANT REFACTOR, or NOT RECOMMENDED, with concrete refactor pointers.
alibabacloud-data-agent-skill
IncludedInvoke Alibaba Cloud Apsara Data Agent for Analytics via CLI to perform natural language-driven data analysis on enterprise databases. Data Agent for Analytics is an intelligent data analysis agent developed by Alibaba Cloud Database team for enterprise users. It automatically completes requirement analysis, data understanding, analysis insights, and report generation based on natural language descriptions. This tool supports: discovering data resources (instances/databases/tables) managed in DMS, initiating query or deep analysis sessions, real-time progress tracking, and retrieving analysis conclusions and generated reports. Use this Skill when users need to query databases, analyze data trends, generate data reports, ask questions in natural language, or mention "Data Agent", "data analysis", "database query", "SQL analysis", "data insights".
token-optimizer
IncludedReduce OpenClaw token usage and API costs through smart model routing, heartbeat optimization, budget tracking, and native 2026.2.15 features (session pruning, bootstrap size limits, cache TTL alignment). Use when token costs are high, API rate limits are being hit, or hosting multiple agents at scale. The 4 executable scripts (context_optimizer, model_router, heartbeat_optimizer, token_tracker) are local-only — no network requests, no subprocess calls, no system modifications. Reference files (PROVIDERS.md, config-patches.json) document optional multi-provider strategies that require external API keys and network access if you choose to use them. See SECURITY.md for full breakdown.
resend-cli
IncludedUse this skill when the task is specifically about operating Resend from an AI agent, terminal session, or CI job via the official resend CLI: installing/authenticating the CLI, sending/listing/updating/cancelling emails, batch sends, domains and DNS, webhooks and local listeners, inbound receiving, contacts, topics, segments, broadcasts, templates, API keys, profiles, or debugging Resend CLI/API failures. Trigger on mentions of Resend CLI, `resend`, `resend doctor`, `resend emails send`, `resend domains`, `resend webhooks listen`, `resend emails receiving`, or agent-friendly terminal automation.
alibabacloud-odps-maxframe-coding
IncludedUse this skill for MaxFrame SDK development and documentation navigation on Alibaba Cloud MaxCompute (ODPS). Helps answer MaxFrame API, concept, official example, and supported pandas API questions; create data processing programs; read/write MaxCompute tables; debug jobs (remote or local); and build custom DPE runtime images. Trigger when users mention MaxFrame, MaxCompute with MaxFrame, ODPS table processing, DPE runtime, MaxFrame docs/examples, DataFrame/Tensor operations, or GPU runtime setup. Works for both English and Chinese queries about Alibaba Cloud data processing with MaxFrame.