oo-component-documentation

Community

Generate precise component docs from code

Authortamago0224
Version1.0.0
Installs0

System Documentation

What problem does it solve?

It eliminates outdated or missing documentation for object‑oriented components by automatically generating or refreshing comprehensive docs directly from the source code.

Core Features & Use Cases

  • Mode detection: Automatically chooses create or update workflow based on provided inputs.
  • Standardized template: Uses a shared Markdown template that enforces architecture, interface, and quality sections.
  • Language‑specific guidance: Tailors analysis for C#, Java, TypeScript/JavaScript, and Python components.
  • Use case: A developer can quickly produce up‑to‑date documentation for a new Go service or keep existing micro‑service docs in sync after refactoring.

Quick Start

Ask the skill to create documentation for the AuthService component located at src/auth/auth_service.go.

Dependency Matrix

Required Modules

None required

Components

referencesassets

💻 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: oo-component-documentation
Download link: https://github.com/tamago0224/kuroshio-mta/archive/main.zip#oo-component-documentation

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 471,000+ vetted skills library on demand.