oo-component-documentation

Name: oo-component-documentation
Availability: InStock
Author: tamago0224

Generate Markdown component documentation from source code across Go, Java, C#, TypeScript, and Python.

Updated Mar 8, 2026

Search Tags:#template #documentation #analysis #component #update #software

Ready to run

npx skills add https://github.com/tamago0224/kuroshio-mta --skill oo-component-documentation

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: oo-component-documentation
Source: https://github.com/tamago0224/kuroshio-mta/tree/main/.agents/skills/oo-component-documentation
Command: npx skills add https://github.com/tamago0224/kuroshio-mta --skill oo-component-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

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.

Frequently Asked Questions about oo-component-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate component documentation from source code automatically?▼

You can generate component documentation from source code by applying a standardized Markdown template to object-oriented components. The system detects inputs, chooses create or update workflows, and produces architecture and API descriptions directly from the codebase.

Can I generate docs for TypeScript and Python components using the same template?▼

Yes, you can generate docs for TypeScript and Python components using the same template. The system applies language-specific analysis guidance for C#, Java, TypeScript, JavaScript, Go, and Python while enforcing standardized architecture and interface sections across all outputs.

How do I update existing micro-service documentation after refactoring?▼

Update existing micro-service documentation after refactoring by triggering the update workflow mode. The system analyzes the modified source code and refreshes the architecture, interface, and quality sections of your existing docs to ensure they remain synchronized with the codebase.

Does this documentation tool work with Go services?▼

Yes, this documentation tool works with Go services. It is explicitly designed to analyze object-oriented components in Go, allowing developers to quickly produce up-to-date architecture and API descriptions for new services or existing micro-services.

What is the best way to standardize API descriptions across multiple object-oriented projects?▼

The best way to standardize API descriptions across multiple object-oriented projects is to use a shared Markdown template that enforces architecture, interface, and quality sections. This ensures comprehensive, accurate, and maintainable documentation across different languages like Java, C#, and Python.

What do I need to provide to generate docs for a new component?▼

To generate docs for a new component, you need to provide the source code location, such as a file path like src/auth/auth_service.go. The system automatically detects the creation mode and analyzes the code to produce the standardized documentation.