PixelPilot api-documentation.instructions.md

API Documentation 2026

Analyse code → extract contracts → generate docs → output structured markdown. Produces README, API reference, JSDoc/TSDoc annotations, and architecture diagrams from source files without requiring external tools.

---

TRIGGER

This skill is activated by:

• /doc [file-or-directory] command
• "document this", "generate docs", "write a README", "API reference for…"
• "explain the architecture of…"

---

STEP 1 — ANALYSE THE TARGET

For a single file

// Read and parse the file
const source = await read_file(targetPath);

// Extract:
// 1. Exported functions/classes/types
// 2. Function signatures (name, params, return type)
// 3. Existing JSDoc/TSDoc comments
// 4. Side effects (DB calls, API calls, mutations)
// 5. Error conditions (thrown errors, rejected promises)

For a directory

# Get the file tree first
find ./src -name "*.ts" -o -name "*.tsx" -o -name "*.js" | sort

# Read key files: index files first, then by depth
# index.ts / index.js → exports → implementation files

---

STEP 2 — CHOOSE DOCUMENTATION TYPE

Requested	Output format
"README"	README.md with overview, install, usage, examples
"API reference"	Per-function/class markdown reference
"Architecture diagram"	Mermaid diagram + text description
"JSDoc / TSDoc"	Inline annotations added to source
"/doc" (unspecified)	README + API reference

---

STEP 3A — README GENERATION

<!-- Template: README.md -->
# {Package / Component Name}

> {One-sentence description of what it does and why it exists.}

## Installation

```bash
npm install {package}
# or
pnpm add {package}

Quick Start

import { {MainExport} } from '{package}';

// Minimal working example
const result = await {MainExport}({
  {requiredParam}: 'value',
});
console.log(result);

Usage

{Use case 1}

// Annotated example with context

{Use case 2}

// …

API Reference

See API.md for the full reference.

Function	Description
{name}(params)	{one-line description}

Configuration

Option	Type	Default	Description
{option}	{type}	{default}	{description}

Error Handling

try {
  await {MainExport}(params);
} catch (err) {
  if (err instanceof {SpecificError}) {
    // handle …
  }
}

Browser / Node Compatibility

{Table or list of supported environments}

Changelog

See CHANGELOG.md.

License

{LICENSE}