Agent skill · Frontend

oo-component-documentation

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

GitHub68,948★ · +463/wk · 2 repos on radarProfile →
copilotMIT
Install
npx skills add github/awesome-copilot --skill oo-component-documentation --agent copilot

Same command for any agent — swap --agent for claude-code, codex, cursor.

Facts
Files in the skill folder: 4
SKILL.md size: 5 KB
Bundled scripts: none
Path: skills/oo-component-documentation/SKILL.md
Open the folder on GitHub →
Where it comes from
Stars: 37,432 · +281 this week
Language: Python

Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.

From the SKILL.md

# 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](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](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

What's inside
Steps it walks through
  1. Determine the mode first
  2. Documentation standards
  3. Shared analysis guidance
  4. Shared output requirements
  5. Language-specific optimizations
  6. Error handling
  7. Workflow
  8. Completion criteria
Ships with 3 files
  • assets/documentation-template.md
  • references/create-mode.md
  • references/update-mode.md
More from awesome-copilot
All skills →
About this skill
What does the oo-component-documentation skill do?

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

How do I install it?

Run `npx skills add github/awesome-copilot --skill oo-component-documentation --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.

Where does this skill come from?

From github/awesome-copilot, a repository with 37,432 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.

Is a popular skill a good skill?

Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.

Keep going