Analyze and refresh object-oriented component documentation to match current implementation.
Works with
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
AI-first code editor with Composer
Before installing skills in Cursor, ensure your development environment meets these requirements:
node --versionupdate-oo-component-documentationExecute the skills CLI command in your project's root directory to begin installation:
Fetches update-oo-component-documentation from github/awesome-copilot and configures it for Cursor.
The CLI shows a list of agents. Use arrow keys and space to select Cursor:
Confirm successful installation by checking the skill directory location:
Restart Cursor to activate update-oo-component-documentation. Access via /update-oo-component-documentation in your agent's command palette.
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 environment. Always review source, verify the publisher, and test in isolation before production.
Submit your Claude Code skill and start earning
Automate repetitive workflows and reduce manual effort
Example
Generate reports, summarize documents, draft communications
Save 3-5 hours per week on routine tasks
Learn new skills, understand complex topics, get expert guidance
Example
Explain concepts, provide examples, suggest learning resources
Accelerate learning and skill development by 2x
Enhance output quality through reviews, suggestions, and refinements
Example
Review drafts, suggest improvements, catch errors
Improve work quality by 30-40% with less effort
0
total installs
0
this week
28.7K
GitHub stars
0
upvotes
Run in your terminal
0
installs
0
this week
28.7K
stars
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:
Analysis Instructions:
Language-Specific Optimizations:
Update Strategy:
last_updated field to current dateError Handling:
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]
| Method/Property | Purpose | Parameters | Return Type | Usage Notes |
|---|---|---|---|---|
| [Update table with current API] |
// Update basic usage example to current API
// Update advanced configuration patterns to current implementation
Prerequisites
Time Estimate
15-45 minutes depending on use case complexity
Steps
Common Pitfalls
✓ Do
✗ Don't
💡 Pro Tips
✓ 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.
github/awesome-copilot
github/awesome-copilot
github/awesome-copilot
github/awesome-copilot
github/awesome-copilot
sammcj/agentic-coding
update-oo-component-documentation has been reliable in day-to-day use. Documentation quality is above average for community skills.
update-oo-component-documentation reduced setup friction for our internal harness; good balance of opinion and flexibility.
update-oo-component-documentation fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.
I recommend update-oo-component-documentation for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.
update-oo-component-documentation is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.
Solid pick for teams standardizing on skills: update-oo-component-documentation is focused, and the summary matches what you get after install.
Useful defaults in update-oo-component-documentation — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.
Keeps context tight: update-oo-component-documentation is the kind of skill you can hand to a new teammate without a long onboarding doc.
update-oo-component-documentation has been reliable in day-to-day use. Documentation quality is above average for community skills.
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