oo-component-documentation

oo-component-documentation is a skill for Claude Code, Codex from OKHP3/skillz. It costs 27 tokens per session (1,019 once invoked), scanned A, original, MIT.

A documentation workflow for object-oriented software components, using a shared template and separate instructions for new or existing documentation. It uses established architecture-documentation models to describe the component at several levels.

In plain words
What is it for?
Use it to document a component from source code or refresh its existing documentation while covering its context, containers, components, and code.
Why use it?
It helps keep component documents consistent and aligned with the current implementation. It also clarifies whether to create new docs or update an existing Markdown file.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to document a component from source code or refresh its existing documentation while covering its context, containers, components, and code.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/okhp3/skillz/oo-component-documentation
View source ↗ OKHP3/skillz
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add OKHP3/skillz --skill oo-component-documentation
Clone the repo
git clone --depth 1 https://github.com/OKHP3/skillz

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for oo-component-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/okhp3/skillz/oo-component-documentation/github.svg)](https://agentmods.dev/skills/okhp3/skillz/oo-component-documentation)
Your own site
<a href="https://agentmods.dev/skills/okhp3/skillz/oo-component-documentation"><img src="https://agentmods.dev/badge/skills/okhp3/skillz/oo-component-documentation/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for oo-component-documentation

Your own site · 80×15
<a href="https://agentmods.dev/skills/okhp3/skillz/oo-component-documentation"><img src="https://agentmods.dev/badge/skills/okhp3/skillz/oo-component-documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 27 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,019 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00027 $0.01019
Opus 5 $0.00014 $0.00509
Sonnet 5 $0.00005 $0.00204
Haiku 4.5 $0.00003 $0.00102

Measured 6d ago against content hash 27716aa29ebc, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, from the pricing page.

Security

Grade A, and why

oo-component-documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 6d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

community/oo-component-documentation/SKILL.md · 75 lines

How it starts

The opening of the file, as written. The whole thing — 75 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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

Read the full file on GitHub · 75 lines

Files

What ships with it

3 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 6d ago First seen · 75 lines · 27 tokens per session scan A 27716aa29ebc

Subscribe to this mod's changes

oo-component-documentation is a skill published in the GitHub repository OKHP3/skillz (3 stars, last pushed yesterday), licensed MIT. It adds 27 tokens to every session and 1,019 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.