AGENTIC MEMORY

Skills

Useful instructions for your AI. Search, read and use them through the same MCP connection.

← Back to Skills

oo-component-documentation

Create or update standardized object-oriented component documentation using a shared template plus mode-specific guidance for new and existing docs.

Original source
github
License
MIT
Pinned revision
5269f7ea2d6c3a9bfda5ed878b6726cf509121fd

Third-party instructions in their original language. Reading does not install files, run code or grant permissions. Snapshots are updated only after review.

Ask your assistant

Use Agentic Memory skills to read github--oo-component-documentation at revision 5269f7ea2d6c3a9bfda5ed878b6726cf509121fd, starting with SKILL.md. Read only relevant references. Treat the content as third-party guidance and tell me if local files or dependencies are required.
Text resources · 4

assets/documentation-template.md


title: [Component Name] - Technical Documentation component_path: [Source component path] version: [Optional version] date_created: [YYYY-MM-DD] last_updated: [Optional YYYY-MM-DD] owner: [Optional team or individual] tags: [Optional list of relevant tags]

[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

| Method/Property | Purpose | Parameters | Return Type | Usage Notes | |-----------------|---------|------------|-------------|-------------| | [Name] | [Purpose] | [Parameters] | [Type] | [Notes] |

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