Skills
.Work. You
Rest

sc-document

Community

Generate focused documentation

Software Engineering#documentation#code generation#technical writing#code comments#user guide#api reference
AuthorTony363
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill automates the creation of various types of documentation, from inline code comments to comprehensive API references and user guides, reducing the manual effort and ensuring consistency.

Core Features & Use Cases

  • Inline Documentation: Generates JSDoc/docstrings for functions, including parameters, returns, and exceptions.
  • API References: Creates detailed documentation for API endpoints, including request/response schemas and usage examples.
  • User Guides: Develops user-focused tutorials and implementation patterns.
  • Use Case: A developer needs to document a new authentication module. They can use this skill to generate inline comments for the code, create an API reference for the endpoints, and produce a brief user guide explaining how to integrate it.

Quick Start

Use the sc-document skill to generate inline documentation for the file src/auth/login.js.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: sc-document
Download link: https://github.com/Tony363/SuperClaude/archive/main.zip#sc-document

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.