documentation-class-analysis-generator

Generate structured Markdown documentation for classes and interfaces from source code.

Updated Jan 6, 2026

Search Tags:#automation #architecture #documentation #analysis #generator #class

Ready to run

npx skills add https://github.com/cslsoftwares/ParamentersORM --skill documentation-class-analysis-generator

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-class-analysis-generator
Source: https://github.com/cslsoftwares/ParamentersORM/tree/main/.cursor/skills/documentation-class-analysis-generator_V1.1.0
Command: npx skills add https://github.com/cslsoftwares/ParamentersORM --skill documentation-class-analysis-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analisa o código-fonte para gerar documentação completa de classes e interfaces, economizando o tempo de documentação manual e padronizando a qualidade.

Core Features & Use Cases

Scan o código-fonte para extrair assinaturas, heranças, interfaces e relacionamentos entre classes.
Writer preenche automaticamente os 7 blocos de documentação por classe, com detalhes de API, relacionamentos e exemplos.
Indexing atualiza o README raiz e o FLOWCHART com links e diagramas de dependências para facilitar a navegação.
Caso de uso: equipes grandes que precisam de documentação consistente para múltiplas linguagens sem escrita manual.

Quick Start

Forneça a raiz do projeto e rode a orquestração para gerar toda a documentação de classes a partir do código-fonte.

Frequently Asked Questions about documentation-class-analysis-generator

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

FAQPage Schema

How do I auto-generate class documentation from source code?▼

To auto-generate class documentation from source code, provide the project root and run the scan phase to extract signatures, then the write phase fills 7-section Markdown docs per class, and the index phase updates the README and Mermaid flowchart.

Can I generate class docs for both Delphi and C# codebases?▼

Yes, class documentation generation supports multiple languages including Pascal, Delphi, and C#, extracting class signatures, inheritances, and interface relationships across diverse large codebases.

What is the best way to document class relationships and dependencies in Markdown?▼

The best way to document class relationships in Markdown is using an automated scan and index process that extracts inheritance and interface usage, producing structured 7-section docs and a Mermaid flowchart for dependency navigation.

How does the scan, write, and index phase workflow generate class docs?▼

The scan phase extracts class signatures and relationships from source code, the write phase generates 7-block Markdown documentation per class, and the index phase creates a root README with links and a Mermaid dependency flowchart.

Do I need a specific folder structure to generate class documentation?▼

Yes, apply this generator to large codebases featuring Analise, Documentation, and Analise directory structures to properly scan source files and output the generated Markdown documentation.

Why standardize class documentation generation across large teams?▼

Standardize class documentation generation across large teams to eliminate manual writing time, ensure consistent API details and usage examples, and maintain unified documentation quality across multiple programming languages.