Agent skill · writing content · github
oo-component-documentation
Create or update standardized object-oriented component documentation using a shared template plus mode-specific guidance for new and existing docs.
Why this skill is useful
Provides specific documentation standards and analysis guidance tailored for object-oriented components that the AI wouldn't reliably generate on its own.
What it needs
About 3k tokens when loaded. Last updated 2026-08-07. 37,534 stars on the source repository.
What this skill does
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: 1. 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. 2. 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. 3. 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. 4. 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. Documentation standards DOC-001: Follow C4 Model documentation levels (Context, Containers, Components, Code) DOC-002: Align with Arc42 software architecture documentation template DOC-003: Comply with IEEE 1016 Software Design Description standard DOC-004: Use Agile Documentation principles (just enough documentation that adds value) DOC-005: Target developers and maintainers as the primary audience Shared analysis guidance ANA-001: Determine the primary component boundary and whether the input represents a folder, file, or existing documentation target ANA-002: Examine source code files for class structures, inheritance, composition, and interfaces ANA-003: Identify design patterns, architectural decisions, and integration points ANA-004: Document or refresh public APIs, interfaces, dependencies, and usage patterns ANA-005: Capture method parameters, return values, asynchronous behavior, exceptions, and lifecycle concerns ANA-006: Assess performance, security, reliability, maintainability, and ex …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills github/oo-component-documentation