Sc Document

Documents

sc-document

Sc Document is an Agent Skill for documents published in the majiayu000/claude-skill-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

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

View on GitHub ↗

QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

Open your project in Codex.
Copy and paste the prompt below.
Review files and risks before approving any action.

Prompt to paste

Inspect the Agent Skill at https://github.com/majiayu000/claude-skill-registry/blob/HEAD/skills/documents/sc-document-tony363-superclaude/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/sc-document, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

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

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

Flags

Flag	Type	Default	Description
`--type`	string	inline	inline, external, api, guide
`--style`	string	detailed	brief, 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

Tool Coordination

Read - Component analysis
Grep - Reference extraction
Write - Documentation creation
Glob - Multi-file documentation