New: 97,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Official agent skill

Oo Component Documentation

by github in github/awesome-copilot

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

OfficialMITAuto-check passedDevelopment

Install Oo Component Documentation

skills CLI
$ npx skills add github/awesome-copilot --skill oo-component-documentation -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install github/awesome-copilot oo-component-documentation --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/oo-component-documentation .claude/skills/oo-component-documentation && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
oo-component-documentation
GitHub stars
40k
Used in
1 other repo
Token cost
~1.3k tokens
SKILL.md length
640 words
Files
4 (incl. references, assets)
Skills in repo
417
Repo updated
First seen
Licence
MIT

At a glance

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

  • Works in 4 steps: Use update mode when the user provides… → Use create mode when the user provides a… → If both code and an existing… → …
  • Development work in your project
  • SKILL.md covers Determine the mode first, Documentation standards, Shared analysis guidance and Shared output requirements, plus 4 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Oo Component Documentation is an agent skill from github/awesome-copilot, published by the product's own GitHub organization. Create or update standardized object-oriented component documentation using a shared template plus mode-specific guidance for new and existing docs.

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. The skill folder holds 5 other files, including reference files and assets (for example `assets/documentation-template.md`, `references/create-mode.md` and `references/update-mode.md`).

It sits in Development. The repository describes itself as: Community-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot. The licence is MIT.

When your agent uses it

  • Development work in your project

Example prompts

  • “/oo-component-documentation”

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Use update mode when the user provides an existing documentation Markdown file, points to a docs path, or explicitly asks to refresh or…
  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…
  3. If both code and an existing documentation file are provided, treat the existing documentation file as the output target and use the…
  4. If the request is ambiguous, infer the mode from the path type whenever possible: existing Markdown documentation file means update mode…

What it can do on your machine

Read from SKILL.md and the folder at commit 727ff2e. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Oo Component Documentation loads about 1.3k tokens when it runs, and up to ~2.3k if it reads all its reference files. Until then it costs about 44 tokens; SKILL.md has 640 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~44
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~2.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from github/awesome-copilot at commit 727ff2e, republished under its MIT licence (© github). 640 words, ~1,346 tokens.

Download SKILL.mdSave it as .claude/skills/oo-component-documentation/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.
name
oo-component-documentation
description
Create or update standardized object-oriented component documentation using a shared template plus mode-specific guidance for new and existing docs.

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.
Show full SKILL.md (260 more words)Show less

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.

© github, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 3 other files (references, assets) in skills/oo-component-documentation of github/awesome-copilot.

  • SKILL.md
  • assets/documentation-template.md
  • references/create-mode.md
  • references/update-mode.md

Open the folder on GitHubat commit 727ff2e

Used in 1 other repository

We found 1 copy of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in github/awesome-copilot, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Oo Component Documentation next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Oo Component Documentation compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Oo Component Documentation this skillgithub/awesome-copilot40k1 repos~1.3kAutomated safety check: PassMIT
Finishing a Development Branchobra/superpowers296k5 repos~1.9kAutomated safety check: PassMIT
Typescript Advanced Typesrolling-scopes/rsschool-app10k24 repos~4.2kAutomated safety check: PassMPL-2.0
PR Babysitteropeninterpreter/openinterpreter69k3 repos~4.2kAutomated safety check: PassApache-2.0
Code Review ChecklistshareAI-lab/learn-claude-code78k5 repos~1.1kAutomated safety check: PassMIT
Greplooponyx-dot-app/onyx32k4 repos~3.3kAutomated safety check: PassMIT

Similar skills

  • Finishing a Development Branch

    obra/superpowers

    Walks the last step of a branch: confirm tests pass, detect the git environment, ask how to integrate, carry out your choice and clean up the worktree.

    296k GitHub starsUsed in 5 repos~1.9k tokens
    DevelopmentAuto-check passed

  • Typescript Advanced Types

    rolling-scopes/rsschool-app

    Master TypeScript's advanced type system including generics, conditional types, mapped types, template literals, and utility types for building type-safe applications.

    10k GitHub starsUsed in 24 repos~4.2k tokens
    DevelopmentAuto-check passed

  • PR Babysitter

    openinterpreter/openinterpreter

    Watches an open GitHub pull request until it merges, handling review comments, diagnosing CI failures and retrying flaky checks along the way.

    69k GitHub starsUsed in 3 repos~4.2k tokens
    DevelopmentAuto-check passed

  • Code Review Checklist

    shareAI-lab/learn-claude-code

    Reviews code against a five-part checklist covering security, correctness, performance, maintainability and testing, and reports findings in a fixed format.

    78k GitHub starsUsed in 5 repos~1.1k tokens
    DevelopmentAuto-check passed

  • Greploop

    onyx-dot-app/onyx

    Iteratively improves a PR (GitHub), MR (GitLab), or shelved changelist (Perforce) until Greptile gives it a 5/5 confidence score with zero unresolved comments.

    32k GitHub starsUsed in 4 repos~3.3k tokens
    DevelopmentAuto-check passed

  • Guidelines

    akash-network/node

    Behavioral guidelines to reduce common LLM coding mistakes. An agent skill from akash-network/node.

    1.1k GitHub starsUsed in 22 repos~577 tokens
    DevelopmentAuto-check passed

More from github/awesome-copilot

All 417 skills in this repo

  • Acquire Codebase Knowledge

    github/awesome-copilot

    Official

    Maps an unfamiliar codebase into seven evidence-backed documents in docs/codebase/, using a scan script and templates, for onboarding or architecture write-ups.

    40k GitHub starsUsed in 1 repo~2.3k tokens
    Auto-check passed

  • Azure Architecture Autopilot

    github/awesome-copilot

    Official

    Designs Azure infrastructure from a natural-language description, or diagrams an existing resource group, then refines the design through conversation and deploys it with Bicep.

    40k GitHub starsUsed in 1 repo~1.9k tokens
    Auto-check passed

  • Draw.io Diagram Generator

    github/awesome-copilot

    Official

    Generates, edits and validates draw.io files with correct mxGraph XML, covering flowcharts, architecture, sequence, ER and UML class diagrams.

    40k GitHub starsUsed in 1 repo~4.9k tokens
    Auto-check passed

  • Credit Risk Data Cleaning

    github/awesome-copilot

    Official

    Cleans raw credit data and screens variables before loan modeling, dropping unstable, noisy or redundant features and writing an Excel report of every step.

    40k GitHub starsUsed in 1 repo~1.5k tokens
    Auto-check passed

  • Daily Focus Board

    github/awesome-copilot

    Official

    Builds a warm, browser-based daily focus board the user updates by talking to their agent, with Eisenhower priorities, a brain-dump box and kind not-today carryover.

    40k GitHub stars~3k tokensUpdated today
    Auto-check passed

  • Python Pypi Package Builder

    github/awesome-copilot

    Official

    End-to-end skill for building, testing, linting, versioning, and publishing a production-grade Python library to PyPI.

    40k GitHub starsUsed in 1 repo~4.6k tokens
    Auto-check passed

Categories

Questions about Oo Component Documentation

What does Oo Component Documentation do?

Create or update standardized object-oriented component documentation using a shared template plus mode-specific guidance for new and existing docs. Oo Component Documentation is an agent skill from github/awesome-copilot, published by the product's own GitHub organization. Create or update standardized object-oriented component documentation using a shared template plus mode-specific guidance for new and existing docs.

When should I use Oo Component Documentation?

Oo Component Documentation fits situations like: development work in your project.

How do I install Oo Component Documentation in Claude Code?

Run `npx skills add github/awesome-copilot --skill oo-component-documentation -a claude-code`. Or copy the skill folder (skills/oo-component-documentation in github/awesome-copilot) into .claude/skills/oo-component-documentation in your project. Claude Code loads it when a task matches its description.

How do I install Oo Component Documentation in Codex?

Run `npx skills add github/awesome-copilot --skill oo-component-documentation -a codex`. Or copy the skill folder (skills/oo-component-documentation in github/awesome-copilot) into .agents/skills/oo-component-documentation in your project. Codex loads it when a task matches its description.

Can I use Oo Component Documentation in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add github/awesome-copilot --skill oo-component-documentation -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/oo-component-documentation, .gemini/skills/oo-component-documentation, .github/skills/oo-component-documentation and .opencode/skills/oo-component-documentation in your project.

What does Oo Component Documentation need to run?

SKILL.md names no scripts, command-line tools or credentials: Oo Component Documentation is instructions for the agent only.

Does Oo Component Documentation access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Oo Component Documentation safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Oo Component Documentation use?

Oo Component Documentation is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Oo Component Documentation use?

About 1.3k tokens (SKILL.md is roughly 5.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 994 tokens, read only when the agent opens those files.

What are the alternatives to Oo Component Documentation?

Skills that share tags, products or a category with Oo Component Documentation: Finishing a Development Branch (obra/superpowers, 296k stars), Typescript Advanced Types (rolling-scopes/rsschool-app, 10k stars), PR Babysitter (openinterpreter/openinterpreter, 69k stars) and Code Review Checklist (shareAI-lab/learn-claude-code, 78k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Oo Component Documentation?

github (a GitHub organization, an official publisher) maintains it in github/awesome-copilot, which has 39,748 GitHub stars. The repository holds 417 skills in this directory. The repository was last updated on October 7, 2026.

Source: github/awesome-copilot on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.