update-oo-component-documentation

github/awesome-copilot · updated Apr 8, 2026

MDX-style export adds YAML metadata + attribution linking explainx.ai and this canonical listing URL.

$npx skills add https://github.com/github/awesome-copilot --skill update-oo-component-documentation
0 commentsdiscussion
summary

Analyze and refresh object-oriented component documentation to match current implementation.

  • Examines source code to identify design patterns, dependencies, interfaces, and architectural changes, then updates existing documentation to reflect the current implementation
  • Supports language-specific optimizations for C#/.NET, Java, TypeScript/JavaScript, and Python with framework-aware analysis
  • Preserves documentation structure and formatting while refreshing all technical content, code
skill.md

Update Standard OO Component Documentation

Update the existing documentation file at: ${file} by analyzing the corresponding component code.

Extract the component path from the existing documentation's front matter (component_path field) or infer it from the documentation content. Analyze the current component implementation and update the documentation accordingly.

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 primary audience

Analysis Instructions:

  • ANA-001: Read existing documentation to understand component context and structure
  • ANA-002: Identify component path from front matter or content analysis
  • ANA-003: Examine current source code files for class structures and inheritance
  • ANA-004: Compare existing documentation with current implementation
  • ANA-005: Identify design patterns and architectural changes
  • ANA-006: Update public APIs, interfaces, and dependencies
  • ANA-007: Recognize new/changed creational/structural/behavioral patterns
  • ANA-008: Update method parameters, return values, exceptions
  • ANA-009: Reassess performance, security, reliability, maintainability
  • ANA-010: Update integration patterns and data flow

Language-Specific Optimizations:

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

Update Strategy:

  • UPD-001: Preserve existing documentation structure and format
  • UPD-002: Update last_updated field to current date
  • UPD-003: Maintain version history in front matter if present
  • UPD-004: Add new sections if component has significantly expanded
  • UPD-005: Mark deprecated features or breaking changes
  • UPD-006: Update examples to reflect current API
  • UPD-007: Refresh dependency lists and versions
  • UPD-008: Update mermaid diagrams to reflect current architecture

Error Handling:

  • ERR-001: Documentation file doesn't exist - provide guidance on file location
  • ERR-002: Component path not found in documentation - request clarification
  • ERR-003: Source code has moved - suggest updated paths
  • ERR-004: Major architectural changes - highlight breaking changes
  • ERR-005: Insufficient access to source - document limitations

Output Format:

Update the existing Markdown file maintaining its structure while refreshing content to match current implementation. Preserve formatting, heading hierarchy, and existing organizational decisions.

Required Documentation Structure:

Update the existing documentation following the same template structure, ensuring all sections reflect current implementation:

---
title: [Component Name] - Technical Documentation
component_path: [Current component path]
version: [Updated version if applicable]
date_created: [Original creation date - preserve]
last_updated: [YYYY-MM-DD - update to current date]
owner: [Preserve existing or update if changed]
tags: [Update tags as needed based on current functionality]
---

# [Component Name] Documentation

[Update introduction to reflect current component purpose and capabilities]

## 1. Component Overview

### Purpose/Responsibility
- OVR-001: Update component's primary responsibility
- OVR-002: Refresh scope (included/excluded functionality)
- OVR-003: Update system context and relationships

## 2. Architecture Section

- ARC-001: Update design patterns used (Repository, Factory, Observer, etc.)
- ARC-002: Refresh internal and external dependencies with current purposes
- ARC-003: Update component interactions and relationships
- ARC-004: Update visual diagrams (UML class, sequence, component)
- ARC-005: Refresh mermaid diagram showing current component structure, relationships, and dependencies

### Component Structure and Dependencies Diagram

Update the mermaid diagram to show current:
- **Component structure** - Current classes, interfaces, and their relationships
- **Internal dependencies** - How components currently interact within the system
- **External dependencies** - Current external libraries, services, databases, APIs
- **Data flow** - Current direction of dependencies and interactions
- **Inheritance/composition** - Current class hierarchies and composition relationships

```mermaid
[Update diagram to reflect current architecture]

3. Interface Documentation

  • INT-001: Update all public interfaces and current usage patterns
  • INT-002: Refresh method/property reference table with current API
  • INT-003: Update events/callbacks/notification mechanisms
Method/Property Purpose Parameters Return Type Usage Notes
[Update table with current API]

4. Implementation Details

  • IMP-001: Update main implementation classes and current responsibilities
  • IMP-002: Refresh configuration requirements and initialization patterns
  • IMP-003: Update key algorithms and business logic
  • IMP-004: Update performance characteristics and bottlenecks

5. Usage Examples

Basic Usage

// Update basic usage example to current API

Advanced Usage

// Update advanced configuration patterns to current implementation
  • USE-001: Update basic usage examples
  • USE-002: Refresh advanced configuration patterns
  • USE-003: Update best practices and recommended patterns

6. Quality Attributes

  • QUA-001: Update security (authentication, authorization, data protection)
  • QUA-002: Refresh performance (characteristics, scalability, resource usage)
  • QUA-003: Update reliability (error handling, fault tolerance, recovery)
  • QUA-004: Refresh maintainability (standards, testing, documentation)
  • QUA-005: Update extensibility (extension points, customization options)

7. Reference Information

  • REF-001: Update dependencies with current versions and purposes
  • REF-002: Refresh configuration options reference
  • REF-003: Update testing guidelines and mock setup
  • REF-004: Refresh troubleshooting (common issues, error messages)
  • REF-005: Update related documentation links
  • REF-006: Add change history and migration notes for this update
how to use update-oo-component-documentation

How to use update-oo-component-documentation on Cursor

AI-first code editor with Composer

1

Prerequisites

Before installing skills in Cursor, ensure your development environment meets these requirements:

  • Cursor installed and configured on your development machine
  • Node.js version 16.0+ with npm package manager (verify with node --version)
  • Active project directory or workspace where you want to add update-oo-component-documentation
2

Execute installation command

Execute the skills CLI command in your project's root directory to begin installation:

$npx skills add https://github.com/github/awesome-copilot --skill update-oo-component-documentation

The skills CLI fetches update-oo-component-documentation from GitHub repository github/awesome-copilot and configures it for Cursor.

3

Select Cursor when prompted

The CLI will show a list of available agents. Use arrow keys to navigate and space to select Cursor:

◆ Which agents do you want to install to?
│ ── Universal (.agents/skills) ── always included ────
│ • Amp
│ • Antigravity
│ • Cline
│ • Codex
│ ●Cursor(selected)
│ • Cursor
│ • Windsurf
4

Verify installation

Confirm successful installation by checking the skill directory location:

.cursor/skills/update-oo-component-documentation

Reload or restart Cursor to activate update-oo-component-documentation. Access the skill through slash commands (e.g., /update-oo-component-documentation) or your agent's skill management interface.

Security & Verification Notice

We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.

Skills execute code in your development environment. Always verify the publisher's identity, review recent commits, and test in isolated environments before production deployment.

List & Monetize Your Skill

Submit your Claude Code skill and start earning

GET_STARTED →

Use Cases

Task Automation & Efficiency

Automate repetitive workflows and reduce manual effort

Example

Generate reports, summarize documents, draft communications

Save 3-5 hours per week on routine tasks

Knowledge Enhancement

Learn new skills, understand complex topics, get expert guidance

Example

Explain concepts, provide examples, suggest learning resources

Accelerate learning and skill development by 2x

Quality Improvement

Enhance output quality through reviews, suggestions, and refinements

Example

Review drafts, suggest improvements, catch errors

Improve work quality by 30-40% with less effort

Implementation Guide

Prerequisites

  • Claude Desktop or compatible AI client with skill support
  • Clear understanding of task or problem to solve
  • Willingness to iterate and refine outputs

Time Estimate

15-45 minutes depending on use case complexity

Installation Steps

  1. 1.Install skill using provided installation command
  2. 2.Test with simple use case relevant to your work
  3. 3.Evaluate output quality and relevance
  4. 4.Iterate on prompts to improve results
  5. 5.Integrate into regular workflow if valuable

Common Pitfalls

  • Expecting perfect results without iteration
  • Not providing enough context in prompts
  • Using skill for tasks outside its intended scope
  • Accepting outputs without review and validation

Best Practices

✓ Do

  • +Start with clear, specific prompts
  • +Provide relevant context and constraints
  • +Review and refine all outputs before using
  • +Iterate to improve output quality
  • +Document successful prompt patterns

✗ Don't

  • Don't use without understanding skill limitations
  • Don't skip validation of outputs
  • Don't share sensitive information in prompts
  • Don't expect skill to replace human judgment

💡 Pro Tips

  • Be specific about desired format and style
  • Ask for multiple options to choose from
  • Request explanations to understand reasoning
  • Combine AI efficiency with human expertise

When to Use This

✓ Use When

Use when skill capabilities match your task, clear ROI on time saved, and you can validate outputs. Best for repetitive tasks, learning, and quality improvement.

✗ Avoid When

Avoid when task requires deep expertise you can't validate, involves sensitive decisions, or when learning process is more valuable than speed of completion.

Learning Path

  1. 1Familiarize yourself with skill capabilities and limitations
  2. 2Start with low-risk, non-critical tasks
  3. 3Progress to more complex and valuable use cases
  4. 4Build expertise through regular use and experimentation

Discussion

Product Hunt–style comments (not star reviews)
  • No comments yet — start the thread.
general reviews

Ratings

4.736 reviews
  • Isabella Anderson· Dec 28, 2024

    update-oo-component-documentation has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • Naina Malhotra· Dec 12, 2024

    update-oo-component-documentation reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • Shikha Mishra· Dec 4, 2024

    update-oo-component-documentation fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.

  • Naina Harris· Dec 4, 2024

    I recommend update-oo-component-documentation for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

  • Yash Thakker· Nov 23, 2024

    update-oo-component-documentation is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.

  • Isabella Li· Nov 23, 2024

    Solid pick for teams standardizing on skills: update-oo-component-documentation is focused, and the summary matches what you get after install.

  • Ishan Thomas· Nov 19, 2024

    Useful defaults in update-oo-component-documentation — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

  • Dhruvi Jain· Oct 14, 2024

    Keeps context tight: update-oo-component-documentation is the kind of skill you can hand to a new teammate without a long onboarding doc.

  • Isabella Thomas· Oct 14, 2024

    update-oo-component-documentation has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • Naina Martin· Oct 10, 2024

    I recommend update-oo-component-documentation for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

showing 1-10 of 36

1 / 4