// Generate focused documentation for components, functions, APIs, and features. Use when creating inline docs, API references, user guides, or technical documentation.
| name | sc-document |
| description | Generate focused documentation for components, functions, APIs, and features. Use when creating inline docs, API references, user guides, or technical documentation. |
Focused documentation for code, APIs, and features.
# Inline documentation
/sc:document src/auth/login.js --type inline
# API reference
/sc:document src/api --type api --style detailed
# User guide
/sc:document payment-module --type guide
| Flag | Type | Default | Description |
|---|---|---|---|
--type | string | inline | inline, external, api, guide |
--style | string | detailed | brief, detailed |
This skill does NOT require hard evidence. Deliverables are:
--type inline)--type external)--type api)--type guide)--style brief)--style detailed)/sc:document src/auth/login.js --type inline
# JSDoc with @param, @returns, @throws
/sc:document src/api --type api --style detailed
# Full endpoint docs with examples
/sc:document payment-module --type guide --style brief
# Quick-start tutorial with common patterns
/sc:document components/ --type external
# README.md for component library