Oo Component Documentation

Generates or refreshes component documentation by analyzing your OO codebase and applying a structured template grounded in C4, Arc42, and IEEE 1016 standards. It automatically picks between create mode (from source code) and update mode (from existing docs), then walks the implementation to document interfaces, dependencies, design patterns, and quality attributes. The output stays honest about what the code actually does rather than inventing behavior, and it flags gaps when source coverage is incomplete. Works across C#, Java, TypeScript, and Python with language-specific handling for async patterns, DI, and module systems. Solid for teams that want architecture docs that stay synchronized with implementation without the usual drift.

skills.sh installs: 1.8K
GitHub stars: 41K
last updated: Aug 21, 2026

View on GitHub

Install

$ npx -y skills add github/awesome-copilot --skill oo-component-documentation --agent claude-code

Installs into .claude/skills of the current project.

Files

OO Component Documentation

Create new documentation for an object-oriented component or update an existing component documentation file by analyzing the current implementation.

Determine the mode first

Choose the workflow before writing anything:

Use update mode when the user provides an existing documentation Markdown file, points to a docs path, or explicitly asks to refresh or revise existing documentation. Follow references/update-mode.md.
Use create mode when the user provides a source file or folder, points to a component path, or asks to generate documentation from code. Follow references/create-mode.md.
If both code and an existing documentation file are provided, treat the existing documentation file as the output target and use the current source code as the source of truth.
If the request is ambiguous, infer the mode from the path type whenever possible: existing Markdown documentation file means update mode; source/component path means create mode.