doc-a
Generate or update standard code documentation — docstrings, rustdoc, API references, READMEs
What this skill does
> **Action skill** — Generate and update standard code documentation: docstrings, rustdoc, API refs, how-tos. ## Target $ARGUMENTS --- Generate or update standard code documentation. This is user-facing documentation that lives alongside the code — not agent design docs (those live in `design-docs/`). ## Core Principle: Brevity Every line must earn its place. Documentation that doesn't get read is useless. Cut ruthlessly. ## Documentation Types ### API Documentation Auto-generated from code. Your job is to ensure the source annotations are complete and correct — not to write separate docs. - **Python**: Docstrings (Google or NumPy style, match existing convention). Module, class, and public function level. - **Rust**: `///` doc comments on public items. Include `# Examples` sections for non-obvious usage. `//!` for module-level docs. - **TypeScript/JavaScript**: JSDoc on exported functions, interfaces, and classes. - **Go**: Package comments and exported symbol comments. What makes good API docs: - First line is a complete sentence describing what it does (not how) - Parameters documented with types and constraints - Return values documented with possible states (including errors) - Examples for anything non-obvious - No implementation details — those change What to skip: - Obvious getters/setters — `get_name` doesn't need "Gets the name" - Private/internal functions unless logic is non-obvious - Re-documenting what the type system already enforces ### How-To Guides Scannable steps with contracts. Written for humans who want to accomplish a specific task. Structure: 1. One sentence: what this guide helps you do 2. Prerequisites (if any) 3. Numbered steps — each step is one action with one observable result 4. Common pitfalls (if they exist) Place near the code they describe. A `README.md` in the relevant package/directory, or a dedicated `docs/` folder for multi-step workflows. ### Architecture Documentation High-level system maps for orientation. These describe what exists and how it connects — not why (that's in `design-docs/`). - Component diagrams showing boundaries and data flow - Entry points and key paths through the system - Dependency relationships - Where to find things Keep current or delete. Stale architecture docs are worse than none. ## When Invoked Assess what's needed based on arguments: - **`api`** — Audit and improve inline documentation (docstrings, doc comments) for the specified scope. Add missing docs on public APIs, fix inaccurate descriptions, add examples where useful. - **`howto`** — Create or update a how-to guide for the specified topic. Scan existing code to extract the actual steps. - **`arch`** — Create or update architecture documentation. Read the actual code structure, don't guess. - **No argument** — Survey the project for documentation gaps. Report what's missing or stale, prioritized by impact. ## Anti-Patterns - Writing docs about code that doesn't exist yet - Repeating what the type signature already says - "In this document, we will explain..." — just explain it - Documenting internal implementation details in public API docs - READMEs that describe aspirational features instead of current behavior
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.