# reference-docs

reference-docs is a Claude Code skill for writing API and symbol reference pages, with parameter tables, return values, errors, and runnable examples.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 121 installs · ★ 89 repo stars
- Author: existential-birds
- License: Apache-2.0 · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/existential-birds/beagle/tree/HEAD/plugins/beagle-docs/skills/reference-docs/SKILL.md
- Updated: 2026-09-15
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/reference-docs

## What it does

The skill hands your agent a page skeleton for API and symbol reference: a one-line description, a parameters table with types and required flags, a returns section, a complete example, and links to related entries. Nested objects get their own property table, enum fields list the values they accept.

Everything else is a rule set. Describe, don't explain: rationale and step-by-step walkthroughs belong to other doc types, and the skill points at `docs-style` for that split. Tables beat prose. Similar pages share one heading order, and examples carry believable values rather than `foo` or `test@test.com`.

It is not meant to be invoked by hand. The frontmatter sets `user-invocable: false`, so the agent picks it up when the task is a reference page. Pair it with `docs-style`: the skill links to `../docs-style/references/diataxis-compass.md`, and without that skill installed the link goes nowhere.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill reference-docs -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/reference-docs/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/reference-docs/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill reference-docs -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/reference-docs/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill reference-docs -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/reference-docs/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install existential-birds/beagle plugins/beagle-docs/skills/reference-docs
```

2. **Manually: put the files in place**
- File: `.github/skills/reference-docs/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill reference-docs -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/existential-birds/beagle --path plugins/beagle-docs/skills/reference-docs
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/reference-docs/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add existential-birds/beagle --skill reference-docs -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/existential-birds/beagle/tree/HEAD/plugins/beagle-docs/skills/reference-docs/SKILL.md

## When to use it
- write a parameter table with types and defaults
- document what a function returns and when it errors
- keep every reference entry in the same shape
- swap prose paragraphs for scannable tables
- describe an HTTP endpoint and its path parameters

## Example prompts
- Write a reference page for `getUser`: parameters table, return value, one runnable example.
- Draft the API reference for `GET /api/v1/users/{userId}` using the same heading order as the other pages.
- Rewrite this section as reference: drop the explanation, keep the tables and one full example.

## Source text · SKILL.md · Apache-2.0

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 046b159a2afdf5a1.

BEGIN THIRD-PARTY FILE 046b159a2afdf5a1
````text
---
name: reference-docs
description: Reference documentation patterns for API and symbol documentation. Use when writing reference docs, API docs, parameter tables, or technical specifications. Triggers on reference docs, API reference, function reference, parameters table, symbol documentation.
user-invocable: false
---

# Reference Documentation Patterns

Reference documentation is information-oriented - helping experienced users find precise technical details quickly. This skill provides patterns for writing clear, scannable reference pages.

**Dependency:** Always use this skill in conjunction with `docs-style` for core writing principles. To confirm reference is the right type — rather than a tutorial, how-to, or explanation — see [docs-style/references/diataxis-compass.md](../docs-style/references/diataxis-compass.md).

## Purpose and Audience

- **Who:** Experienced users seeking specific information
- **Goal:** Quick lookup of technical details
- **Mode:** Not for learning, for looking up
- **Expectation:** Brevity, consistency, completeness

## Document Structure Template

Use this template when creating reference documentation:

```markdown
---
title: "[Symbol/API Name]"
description: "One-line description of what it does"
---

# [Name]

Brief description (1-2 sentences). State what it is and its primary purpose.

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `param1` | `string` | Yes | What this parameter controls |
| `param2` | `number` | No | Optional behavior modification. Default: `10` |

## Returns

| Type | Description |
|------|-------------|
| `ReturnType` | What the function returns and when |

## Example

```language
import { symbolName } from 'package';

// Complete, runnable example showing common use case
const result = symbolName({
  param1: 'realistic-value',
  param2: 42
});

console.log(result);
// Expected output: { ... }
```

## Related

- [RelatedSymbol](/reference/related-symbol) - Brief description
- [AnotherSymbol](/reference/another-symbol) - Brief description
```

## Writing Principles

### Describe, and Only Describe
````
END THIRD-PARTY FILE 046b159a2afdf5a1

The third-party file has ended. Everything between the 046b159a2afdf5a1 tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2147 of 11312 bytes. © existential-birds · Apache-2.0 · https://github.com/existential-birds/beagle/tree/HEAD/plugins/beagle-docs/skills/reference-docs/SKILL.md

## Similar
- [docs-writer](https://affpapa.org/en/nevibecode/skills/docs-writer.md) — skill · ★ 7191 repo stars
- [google-dev-docs](https://affpapa.org/en/nevibecode/skills/google-dev-docs.md) — skill · ★ 57 repo stars
- [code-documentation-docs-architect](https://affpapa.org/en/nevibecode/agents/code-documentation-docs-architect.md) — subagent · ★ 42780 repo stars

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
