MCPInstall

sc-document

Generate focused documentation for components, functions, APIs, and features. Use when creating inline docs, API references, user guides, or technical documentation.

Installs
94
Last 24h
—
Trending rank
—
Security
Not audited

Install

Works with every agent the skills CLI supports.

npx skills add https://github.com/tony363/superclaude --skill sc-document
  1. 01

    Install

    Run the command in your project. The CLI asks which agents to install for.

  2. 02

    Describe the task

    Ask your agent for something this skill covers. It loads sc-document automatically when relevant.

  3. 03

    Review the result

    The agent follows the SKILL.md steps, scripts and references bundled with the skill.

SKILL.md

The instructions your agent reads when the skill is triggered.

Documentation Generation Skill

Focused documentation for code, APIs, and features.

Quick Start

# 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

Behavioral Flow

  1. Analyze - Examine component structure and functionality
  2. Identify - Determine documentation requirements and audience
  3. Generate - Create appropriate documentation content
  4. Format - Apply consistent structure and patterns
  5. Integrate - Ensure compatibility with existing docs

Flags

FlagTypeDefaultDescription
--typestringinlineinline, external, api, guide
--stylestringdetailedbrief, detailed

Evidence Requirements

This skill does NOT require hard evidence. Deliverables are:

  • Generated documentation files
  • Inline code comments
  • API reference materials

Documentation Types

Inline (--type inline)

  • JSDoc/docstring generation
  • Parameter and return descriptions
  • Function-level comments

External (--type external)

  • Standalone documentation files
  • Component overviews
  • Integration guides

API (--type api)

  • Endpoint documentation
  • Request/response schemas
  • Usage examples

Guide (--type guide)

  • User-focused tutorials
  • Implementation patterns
  • Common use cases

Style Options

Brief (--style brief)

  • Concise descriptions
  • Essential information only
  • Quick reference format

Detailed (--style detailed)

  • Comprehensive explanations
  • Extended examples
  • Edge case coverage

Examples

Inline Code Docs

/sc:document src/auth/login.js --type inline
# JSDoc with @param, @returns, @throws

API Reference

/sc:document src/api --type api --style detailed
# Full endpoint docs with examples

User Guide

/sc:document payment-module --type guide --style brief
# Quick-start tutorial with common patterns

Component Docs

/sc:document components/ --type external
# README.md for component library

MCP Integration

PAL MCP (Quality & Research)

ToolWhen to UsePurpose
mcp__pal__codereviewAPI docsReview documentation accuracy
mcp__pal__apilookupExternal APIsGet current API documentation
mcp__pal__chatWriting assistanceGet help with complex explanations
mcp__pal__consensusStyle decisionsMulti-model validation of doc approach

PAL Usage Patterns

# 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"
)

Rube MCP (Publishing & Collaboration)

ToolWhen to UsePurpose
mcp__rube__RUBE_SEARCH_TOOLSDoc platformsFind Notion, Confluence, GitBook
mcp__rube__RUBE_MULTI_EXECUTE_TOOLPublishingPush docs to platforms
mcp__rube__RUBE_REMOTE_WORKBENCHBulk docsGenerate docs for large codebases

Rube Usage Patterns

# 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
'''
)

Flags (Extended)

FlagTypeDefaultDescription
--pal-reviewboolfalseUse PAL to review doc accuracy
--publishstring-Publish via Rube (notion, confluence, gitbook)
--notifystring-Notify via Rube (slack, teams, email)

Tool Coordination

  • Read - Component analysis
  • Grep - Reference extraction
  • Write - Documentation creation
  • Glob - Multi-file documentation
  • PAL MCP - Accuracy review, API lookup, writing assistance
  • Rube MCP - Publishing, notifications, bulk generation

FAQ

What does the sc-document skill do?

Generate focused documentation for components, functions, APIs, and features. Use when creating inline docs, API references, user guides, or technical documentation.

How do I install sc-document?

Run npx skills add https://github.com/tony363/superclaude --skill sc-document in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/sc-document/ (personal) or .claude/skills/sc-document/ (project).

Which AI agents can use sc-document?

Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.

Is sc-document safe to install?

No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.

Who maintains sc-document?

It is published by tony363 in tony363/superclaude. It has 94 recorded installs.

More from tony363/superclaude

View all →

agent-performance-engineer

tony363/superclaude

Expert performance engineer specializing in system optimization, bottleneck identification, and scalability engineering. Masters performance testing, profiling, and tuning across applications, databases, and infrastructure with focus on achieving optimal response times and resource efficiency.

agent-security-engineer

tony363/superclaude

Expert infrastructure security engineer specializing in DevSecOps, cloud security, and compliance frameworks. Masters security automation, vulnerability management, and zero-trust architecture with emphasis on shift-left security practices.

Security392 installs

sc-estimate

tony363/superclaude

Provide development estimates for tasks, features, or projects with intelligent analysis. Use when planning timelines, assessing complexity, or scoping resources.

agent-fullstack-developer

tony363/superclaude

End-to-end feature owner with expertise across the entire stack. Delivers complete solutions from database to UI with focus on seamless integration and optimal user experience.

Frontend & Design154 installs

sc-design

tony363/superclaude

Design system architecture, APIs, and component interfaces with comprehensive specifications. Use when planning architecture, designing APIs, creating component interfaces, or modeling databases.

Frontend & Design113 installs

agent-technical-writer

tony363/superclaude

Open the skill to read its SKILL.md instructions.

Docs & Writing108 installs

Popular docs & writing skills

View category →

grill-with-docs

mattpocock/skills

A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.

Docs & Writing1.2M installs

lark-markdown

open.feishu.cn

飞书 Markdown:查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件,或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档,也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。

Docs & Writing778.7K installs

writing-beats

mattpocock/skills

Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.

Docs & Writing490.7K installs

writing-shape

mattpocock/skills

Writing, exploit: shape raw material into an article, paragraph by paragraph.

Docs & Writing490.2K installs

writing-fragments

mattpocock/skills

Writing, explore: mine raw fragments, no structure yet.

Docs & Writing489.6K installs

writing-for-agents

mattpocock/skills

Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.

Docs & Writing479.3K installs