update-oo-component-documentation

Overview

Update OO Component Documentation is a skill that automatically analyzes object-oriented source code and updates existing component documentation to match the current implementation. It follows industry standards including C4 Model, Arc42, and IEEE 1016 to produce documentation that accurately reflects class structures, design patterns, public APIs, and architectural decisions.

Key Features

• Standards-Compliant Documentation - Follows C4 Model levels, Arc42 template structure, and IEEE 1016 Software Design Description standards for consistent documentation
• Multi-Language Support - Provides language-specific optimizations for C#/.NET, Java, TypeScript/JavaScript, and Python including framework-specific patterns like dependency injection, async/await, and module systems
• Automated Implementation Comparison - Reads existing documentation, identifies the component path, examines current source code, and highlights changes between documented and actual implementations
• Design Pattern Recognition - Detects creational, structural, and behavioral design patterns and documents their usage within the component architecture
• Quality Attribute Assessment - Evaluates and documents performance, security, reliability, and maintainability characteristics of components

Who is this for?

This skill is ideal for development teams maintaining large object-oriented codebases where documentation frequently falls out of sync with implementation. It is especially useful for architects and senior developers responsible for keeping component documentation accurate across C#, Java, TypeScript, or Python projects.