Loading...
Loading...
Generate focused documentation for components, functions, APIs, and features. Use when creating inline docs, API references, user guides, or technical documentation.
npx skill4agent add tony363/superclaude sc-document# 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 |
|---|---|---|---|
| string | inline | inline, external, api, guide |
| string | detailed | brief, detailed |
--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| Tool | When to Use | Purpose |
|---|---|---|
| API docs | Review documentation accuracy |
| External APIs | Get current API documentation |
| Writing assistance | Get help with complex explanations |
| Style decisions | Multi-model validation of doc approach |
# Verify documentation accuracy
mcp__pal__codereview(
review_type="quick",
step="Reviewing API documentation for accuracy",
findings="Parameter descriptions, return types, examples",
relevant_files=["/docs/api/auth.md"]
)
# Get current API docs for external integration
mcp__pal__apilookup(
prompt="Get current Stripe API documentation for payment intents"
)
# Writing assistance for complex topics
mcp__pal__chat(
prompt="Help me explain the OAuth2 authorization code flow clearly for developers",
model="gpt-5.2"
)| Tool | When to Use | Purpose |
|---|---|---|
| Doc platforms | Find Notion, Confluence, GitBook |
| Publishing | Push docs to platforms |
| Bulk docs | Generate docs for large codebases |
# Publish documentation
mcp__rube__RUBE_MULTI_EXECUTE_TOOL(tools=[
{"tool_slug": "NOTION_CREATE_PAGE", "arguments": {
"title": "API Reference: Authentication",
"content": "## Endpoints\n### POST /auth/login\n..."
}},
{"tool_slug": "CONFLUENCE_CREATE_PAGE", "arguments": {
"space": "DEV",
"title": "Auth API Documentation",
"content": "..."
}}
])
# Notify team of new docs
mcp__rube__RUBE_MULTI_EXECUTE_TOOL(tools=[
{"tool_slug": "SLACK_SEND_MESSAGE", "arguments": {
"channel": "#documentation",
"text": "New API docs published: Authentication endpoints"
}}
])
# Bulk generate docs
mcp__rube__RUBE_REMOTE_WORKBENCH(
thought="Generate JSDoc for all exported functions",
code_to_execute='''
import os
# Process all JS files and generate documentation
# Use invoke_llm for each function
'''
)| Flag | Type | Default | Description |
|---|---|---|---|
| bool | false | Use PAL to review doc accuracy |
| string | - | Publish via Rube (notion, confluence, gitbook) |
| string | - | Notify via Rube (slack, teams, email) |