class-hierarchy-extraction
Summary
Extract and visualize the class hierarchy, inheritance relationships, and module boundaries from object-oriented source code to identify extension points and developer entry points for software enhancement. This skill enables developers to navigate modular architectures and locate abstract classes, interfaces, and factory patterns suitable for extension.
When to use
Apply this skill when you need to understand the extensibility surface of a modular object-oriented codebase, particularly when planning to contribute new modules, extend existing functionality, or onboard developers unfamiliar with the architecture. Use it specifically when the software is designed to meet OOP standards and explicitly supports community-driven extension.
When NOT to use
- Source code is not structured using object-oriented design principles or lacks public class definitions and interfaces.
- Software is not designed for modularity or community extension — refactoring may be required before this skill adds value.
- Input is already a pre-compiled, closed-source binary without accessible source code.
Inputs
- Git repository URL or local source tree
- Object-oriented source code (Java, Python, C++, or similar)
- Software architecture documentation (if available)
Outputs
- Class hierarchy diagram (PlantUML, UML, or equivalent structured format)
- Annotated extension points (abstract classes, interfaces, factory patterns)
- Module boundary map showing composition and inheritance relationships
How to apply
Clone the target repository using Git, then perform static analysis on the source code to identify all class definitions, method signatures, inheritance chains, and composition relationships. Extract public classes, abstract base classes, interfaces, and documented extension mechanisms (factory patterns, plugin architectures, abstract methods). Generate a structured diagram in PlantUML or equivalent format that represents the module hierarchy and relationship tree, explicitly marking extension points where developers can inject custom behavior. Validate the generated diagram against the source code to ensure all public classes and their documented extension mechanisms are present and accurately represented.
Related tools
- Docker (Containerized environment for running static analysis and code parsing tools without local dependency conflicts)
- Git (Version control for cloning and accessing the source repository)
- PlantUML (Diagram generation and visualization tool for rendering class hierarchies and UML relationships)
Evaluation signals
- All public classes present in source code appear in the generated diagram without omissions
- Inheritance and composition relationships in the diagram match the actual parent-child and has-a relationships in the code
- Extension points (abstract classes, interfaces, factory patterns) are explicitly annotated and match documentation
- Module boundaries are clearly delineated, allowing developers to locate specific components for modification
- Diagram passes validation check: static analysis re-run produces identical or semantically equivalent class definitions
Limitations
- Static analysis may miss runtime polymorphism, dynamic type loading, or reflection-based extension mechanisms not visible in source.
- Effectiveness depends on code quality and documentation; poorly documented extension points may not be identified automatically.
- Large codebases may produce visually complex diagrams that require hierarchical filtering or modularization to remain readable.
- No changelog or versioning metadata found for CloMet; diagram may not reflect evolution of extension points across releases.
Evidence
- [readme] The software has been designed in such a modular way meeting the Object Oriented Programming standards to facilitate the extension of its capabilities: "The software has been designed in such a modular way meeting the Object Oriented Programming standards to facilitate the extension of its capabilities"
- [readme] we have released the class diagram of the software, so developers can go directly to those modules that they want to improve/extend: "we have released the class diagram of the software, so developers can go directly to those modules that they want to improve/extend"
- [other] Extract class definitions, method signatures, and module boundaries that represent extension points (abstract classes, interfaces, factory patterns): "Extract class definitions, method signatures, and module boundaries that represent extension points (abstract classes, interfaces, factory patterns)"
- [other] Generate a structured class diagram in PlantUML or equivalent format that visualizes the module hierarchy, class relationships, and developer extension points: "Generate a structured class diagram in PlantUML or equivalent format that visualizes the module hierarchy, class relationships, and developer extension points"
- [other] Validate the diagram against source code to ensure all public classes and their documented extension mechanisms are represented: "Validate the diagram against source code to ensure all public classes and their documented extension mechanisms are represented"
1---2name: class-hierarchy-extraction3description: Use when you need to understand the extensibility surface of a modular object-oriented codebase, particularly when planning to contribute new modules, extend existing functionality, or onboard developers unfamiliar with the architecture.4license: CC-BY-4.05---67# class-hierarchy-extraction89## Summary1011Extract and visualize the class hierarchy, inheritance relationships, and module boundaries from object-oriented source code to identify extension points and developer entry points for software enhancement. This skill enables developers to navigate modular architectures and locate abstract classes, interfaces, and factory patterns suitable for extension.1213## When to use1415Apply this skill when you need to understand the extensibility surface of a modular object-oriented codebase, particularly when planning to contribute new modules, extend existing functionality, or onboard developers unfamiliar with the architecture. Use it specifically when the software is designed to meet OOP standards and explicitly supports community-driven extension.1617## When NOT to use1819- Source code is not structured using object-oriented design principles or lacks public class definitions and interfaces.20- Software is not designed for modularity or community extension — refactoring may be required before this skill adds value.21- Input is already a pre-compiled, closed-source binary without accessible source code.2223## Inputs2425- Git repository URL or local source tree26- Object-oriented source code (Java, Python, C++, or similar)27- Software architecture documentation (if available)2829## Outputs3031- Class hierarchy diagram (PlantUML, UML, or equivalent structured format)32- Annotated extension points (abstract classes, interfaces, factory patterns)33- Module boundary map showing composition and inheritance relationships3435## How to apply3637Clone the target repository using Git, then perform static analysis on the source code to identify all class definitions, method signatures, inheritance chains, and composition relationships. Extract public classes, abstract base classes, interfaces, and documented extension mechanisms (factory patterns, plugin architectures, abstract methods). Generate a structured diagram in PlantUML or equivalent format that represents the module hierarchy and relationship tree, explicitly marking extension points where developers can inject custom behavior. Validate the generated diagram against the source code to ensure all public classes and their documented extension mechanisms are present and accurately represented.3839## Related tools4041- **Docker** (Containerized environment for running static analysis and code parsing tools without local dependency conflicts)42- **Git** (Version control for cloning and accessing the source repository)43- **PlantUML** (Diagram generation and visualization tool for rendering class hierarchies and UML relationships)4445## Evaluation signals4647- All public classes present in source code appear in the generated diagram without omissions48- Inheritance and composition relationships in the diagram match the actual parent-child and has-a relationships in the code49- Extension points (abstract classes, interfaces, factory patterns) are explicitly annotated and match documentation50- Module boundaries are clearly delineated, allowing developers to locate specific components for modification51- Diagram passes validation check: static analysis re-run produces identical or semantically equivalent class definitions5253## Limitations5455- Static analysis may miss runtime polymorphism, dynamic type loading, or reflection-based extension mechanisms not visible in source.56- Effectiveness depends on code quality and documentation; poorly documented extension points may not be identified automatically.57- Large codebases may produce visually complex diagrams that require hierarchical filtering or modularization to remain readable.58- No changelog or versioning metadata found for CloMet; diagram may not reflect evolution of extension points across releases.5960## Evidence6162- [readme] The software has been designed in such a modular way meeting the Object Oriented Programming standards to facilitate the extension of its capabilities: "The software has been designed in such a modular way meeting the Object Oriented Programming standards to facilitate the extension of its capabilities"63- [readme] we have released the class diagram of the software, so developers can go directly to those modules that they want to improve/extend: "we have released the class diagram of the software, so developers can go directly to those modules that they want to improve/extend"64- [other] Extract class definitions, method signatures, and module boundaries that represent extension points (abstract classes, interfaces, factory patterns): "Extract class definitions, method signatures, and module boundaries that represent extension points (abstract classes, interfaces, factory patterns)"65- [other] Generate a structured class diagram in PlantUML or equivalent format that visualizes the module hierarchy, class relationships, and developer extension points: "Generate a structured class diagram in PlantUML or equivalent format that visualizes the module hierarchy, class relationships, and developer extension points"66- [other] Validate the diagram against source code to ensure all public classes and their documented extension mechanisms are represented: "Validate the diagram against source code to ensure all public classes and their documented extension mechanisms are represented"
HolobiomicsLab