write-reference

Included with Lifetime

$97 forever

Create information-oriented documentation for lookup and reference. PROACTIVELY activate for: (1) API documentation, (2) configuration reference, (3) glossaries and terminology, (4) technical specifications, (5) parameter documentation. Triggers: "write reference", "create reference docs", "API documentation", "config reference", "document parameters", "glossary", "specification"

Backend & APIs

What this skill does


# Write Reference

Generate information-oriented documentation optimized for quick lookup and accuracy.

## When to Use

Use this skill when you need documentation that:
- Provides accurate, complete information for lookup
- Describes APIs, configurations, or system parameters
- Serves as authoritative source of truth
- Is structured for quick scanning and finding

## Workflow

Invoke the `create-documentation` skill for: "$ARGUMENTS"

### Parameters to Apply

| Parameter | Value | Rationale |
|-----------|-------|-----------|
| `doc_type` | reference | Information-oriented, lookup-focused |
| `persona` | developer | Technical reader seeking specific answers |
| `reading_level` | professional | Technical accuracy over accessibility |
| `include_examples` | true | Examples clarify usage |
| `validation_depth` | comprehensive | Reference docs must be accurate |

### Required Elements

1. **Consistent structure** - Every entry follows the same format
2. **Complete coverage** - All items documented, no gaps
3. **Self-contained entries** - Each entry understandable in isolation
4. **Accurate types/constraints** - Precise technical specifications
5. **Default values documented** - What happens if not specified
6. **Examples for each item** - Concrete usage demonstrations

### Cognitive Load Management

- **Intrinsic**: Accept it - readers are technical professionals
- **Extraneous**: Minimize - no unnecessary prose, consistent format
- **Germane**: Focus on - examples, edge cases, gotchas

### Reference Documentation Patterns

**API Endpoint Pattern:**
```markdown
### `POST /api/v1/resource`

Create a new resource.

**Request Body:**
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| name | string | Yes | Resource name (max 255 chars) |
| config | object | No | Configuration options |

**Response:**
| Status | Description |
|--------|-------------|
| 201 | Created successfully |
| 400 | Validation error |
| 401 | Unauthorized |

**Example:**
\`\`\`bash
curl -X POST /api/v1/resource \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"name": "example"}'
\`\`\`
```

**Configuration Parameter Pattern:**
```markdown
### `max_connections`

Maximum number of simultaneous connections.

| Property | Value |
|----------|-------|
| Type | integer |
| Default | 100 |
| Range | 1-10000 |
| Environment | `APP_MAX_CONNECTIONS` |

**Behavior:**
- Values below 10 may cause timeouts under load
- Values above 1000 require tuning OS limits

**Example:**
\`\`\`yaml
database:
  max_connections: 500
\`\`\`
```

**Glossary Entry Pattern:**
```markdown
### Term Name

**Definition:** One-sentence definition.

**Context:** Where/when this term is used.

**Related:** [Link to related terms]

**Example:** Usage in a sentence.
```

## Output Format

The generated reference should follow this structure:

```markdown
# [System/API/Configuration] Reference

> Version: [version] | Last updated: [date]

## Overview

[Brief context - what this documents and when to use it]

## Quick Reference

[Table or list of all items for scanning]

## Detailed Reference

### [Category 1]

#### `item_name`

[Consistent documentation following pattern]

### [Category 2]

#### `item_name`

[Same pattern repeated]

## Common Patterns

[Frequently used combinations or configurations]

## Troubleshooting

| Symptom | Cause | Solution |
|---------|-------|----------|

## Changelog

| Version | Changes |
|---------|---------|
```

## Quality Gates

- [ ] Every item follows consistent format
- [ ] No missing items (complete coverage)
- [ ] Types and constraints accurate
- [ ] Default values documented
- [ ] Examples provided for each item
- [ ] Self-contained entries (no assumed context)
- [ ] Quick reference table for scanning
- [ ] Version and update date included

## Documentation Type Selection Guide

| Need | Doc Type | Skill |
|------|----------|-------|
| Teach a concept | Tutorial | `/write-tutorial` |
| Help accomplish task | How-To | `/write-howto` |
| Explain why/how | Explanation | (use create-documentation directly) |
| Look up information | Reference | `/write-reference` |

## Related Skills

After creating reference documentation, consider:
- Run `/write-tutorial` for onboarding new users
- Run `/write-howto` for common tasks
- Run `/optimize-prompt` if documenting AI/prompting features

Files: 1

Size: 4.7 KB

Complexity: 16/100

Category: Backend & APIs

Source: https://github.com/agentient/vibekit/tree/main/plugins/documentation-tools/skills/write-reference

Related in Backend & APIs

jfrog

Included

Interact 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.

Backend & APIsscripts

cupynumeric-migration-readiness

Included

Pre-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.

Backend & APIsscripts

alibabacloud-data-agent-skill

Included

Invoke 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".

Backend & APIsscripts

token-optimizer

Included

Reduce 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.

Backend & APIsscripts

resend-cli

Included

Use 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.

Backend & APIsscripts

alibabacloud-odps-maxframe-coding

Included

Use 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.

Backend & APIsscripts