Oo Component Documentation

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 extensibility characteristics
• ANA-007: Infer data flow, collaboration patterns, and relationships with surrounding components
• ANA-008: Keep the documentation grounded in the implementation; avoid inventing behavior that is not supported by the code

Shared output requirements

• Use assets/documentation-template.md as the canonical section checklist and baseline structure.
• Keep the output in Markdown with a clear heading hierarchy, tables where useful, code blocks for examples, and Mermaid diagrams when architecture relationships need to be visualized.
• Make examples and interface descriptions match the current implementation instead of generic placeholders.
• Include only information that can be supported by the code, project structure, configuration, or clearly stated assumptions.
• When source coverage is incomplete, document the limitation explicitly instead of guessing.

Language-specific optimizations

• LNG-001: C#/.NET - async/await, dependency injection, configuration, disposal, options patterns
• LNG-002: Java - Spring framework, annotations, exception handling, packaging, dependency injection
• LNG-003: TypeScript/JavaScript - modules, async patterns, types, npm dependencies, runtime boundaries
• LNG-004: Python - packages, virtual environments, type hints, testing, dependency management

Error handling

• ERR-001: If the path does not exist, explain what path was expected and whether the skill needs a source path or an existing documentation file
• ERR-002: If no relevant source files are found, document the gap and suggest the likely locations to inspect next
• ERR-003: If the documentation target cannot be inferred from the request, state the ambiguity and ask for the missing path only when inference is not possible
• ERR-004: If the code uses non-standard architectural patterns, document the custom approach rather than forcing it into a generic pattern
• ERR-005: If source access is incomplete, continue with available evidence and clearly call out any unsupported sections

Workflow

1. Determine whether the task is create mode or update mode. 2. Inspect the component implementation and any related files needed to understand its public surface area and internal structure. 3. Use assets/documentation-template.md as the shared documentation scaffold. 4. Apply the mode-specific rules in references/create-mode.md or references/update-mode.md. 5. Produce or revise the documentation so that diagrams, examples, interfaces, dependencies, and quality attributes reflect the current implementation.

Completion criteria

• The documentation clearly identifies the component purpose, architecture, interfaces, implementation details, usage patterns, quality attributes, and references.
• Front matter fields are accurate for the selected mode.
• Examples and diagrams match the implementation.
• Any unknowns, gaps, or assumptions are explicitly called out.

[Component Name] Documentation

[Concise introduction describing the component purpose and role in the system.]

1. Component Overview

Purpose/Responsibility

• OVR-001: State the component's primary responsibility
• OVR-002: Define scope, including included and excluded responsibilities
• OVR-003: Describe system context and major relationships

2. Architecture Section

• ARC-001: Document design patterns used
• ARC-002: List internal and external dependencies with their purpose
• ARC-003: Describe component interactions and relationships
• ARC-004: Include visual diagrams where they clarify structure or behavior
• ARC-005: Provide a Mermaid diagram showing structure, relationships, and dependencies

Component Structure and Dependencies Diagram

Show the current:

• Component structure
• Internal dependencies
• External dependencies
• Data flow
• Inheritance and composition relationships

graph TD
    A[Primary Component] --> B[Collaborator]
    A --> C[Dependency]

3. Interface Documentation

• INT-001: Document public interfaces and usage patterns
• INT-002: Provide a method or property reference table
• INT-003: Cover events, callbacks, or notification mechanisms when applicable

4. Implementation Details

• IMP-001: Describe main implementation classes and responsibilities
• IMP-002: Capture configuration requirements and initialization patterns
• IMP-003: Summarize key algorithms or business logic
• IMP-004: Note performance characteristics and bottlenecks

5. Usage Examples

Basic Usage

[Basic usage example aligned with the component language and API]

Advanced Usage

[Advanced configuration or orchestration example aligned with the current implementation]

• USE-001: Provide basic usage examples
• USE-002: Show advanced configuration patterns
• USE-003: Document best practices and recommended patterns

6. Quality Attributes

• QUA-001: Security
• QUA-002: Performance
• QUA-003: Reliability
• QUA-004: Maintainability
• QUA-005: Extensibility

7. Reference Information

• REF-001: List dependencies with versions and purposes where available
• REF-002: Document configuration options
• REF-003: Provide testing guidance and mock setup notes
• REF-004: Capture troubleshooting notes and common issues
• REF-005: Link related documentation
• REF-006: Add change history or migration notes when relevant

Create mode

Use this workflow when the input is a component source path or the user asks to generate new documentation from code.

Input handling

• Accept a single file or a folder path representing the component.
• If the input is a folder, analyze the relevant source files in that folder and nearby supporting files.
• If the input is a single file, treat it as the primary component entry point and inspect adjacent files as needed to understand collaborators and interfaces.

Create-specific requirements

• Save the new documentation in /docs/components/.
• Name the file [component-name]-documentation.md.
• Set component_path to the source path provided by the user.
• Set date_created to the current date.
• Set last_updated only if the repository convention for the target area expects it at creation time.
• Populate optional metadata such as version, owner, and tags only when they can be inferred reliably.

Create-specific analysis focus

• Determine the primary component name and responsibilities from the code structure.
• Identify the initial system context, scope boundaries, dependencies, design patterns, and collaboration model.
• Build interface tables and usage examples from the actual public surface area.
• Create a Mermaid diagram that introduces the component structure, dependencies, and data flow for a reader seeing the documentation for the first time.

Create-specific output guidance

• Use the full section structure from ../assets/documentation-template.md.
• Write the introduction as a fresh overview of what the component does and why it exists.
• Prefer complete sections over placeholders; if information is unavailable, mark the section with a short limitation note instead of leaving template text behind.
• Include change history or migration notes only if there is evidence of prior versions or migration concerns in the code or repository history.

Update mode

Use this workflow when the input is an existing documentation Markdown file or the user asks to refresh existing component documentation.

Input handling

• Read the existing documentation first to understand the current structure, terminology, and any front matter metadata.
• Extract the component source path from the component_path front matter when present.
• If component_path is missing, infer the component path from the documentation content and surrounding repository structure.
• Use the current implementation as the source of truth when the documentation and code disagree.

Update-specific requirements

• Preserve the existing documentation file as the output target.
• Preserve date_created.
• Update last_updated to the current date.
• Preserve version history and ownership metadata when still accurate; refresh them only when the code or repository evidence indicates they have changed.
• Maintain the existing organization where it is still useful, but ensure the content remains consistent with the shared template expectations.

Update-specific analysis focus

• Compare the existing documentation with the current code to identify stale APIs, outdated diagrams, renamed dependencies, and changed usage patterns.
• Highlight breaking changes, deprecated features, or major architectural shifts when they are evident.
• Refresh method tables, examples, diagrams, dependency lists, and quality attribute notes to match the implementation as it exists today.
• Add missing sections only when the component has grown or the current documentation omits information now needed for maintainers.

Update-specific output guidance

• Keep useful editorial choices from the existing document, but remove stale or misleading content.
• Update examples so they compile conceptually against the current API shape.
• Refresh Mermaid diagrams rather than replacing them with generic placeholders.
• Add migration notes or change history when the update reveals important compatibility or behavior changes.