oo-component-documentation SKILL.md skillA
oo-component-documentation from okhp3/skillz is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add okhp3/skillz/oo-component-documentation@git:20260828.866dec6Pins git:20260828.866dec6 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- okhp3/skillz
- Path
community/oo-component-documentation/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260828.866dec6, committed Aug 28, 2026
- Size
- 5,384 bytes
- Repository stars
- 3
- License
- MIT
Create or update standardized object-oriented component documentation using a shared template plus mode-specific guidance for new and existing docs.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# 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) …
Read the whole file at its exact version.
How to install
mdr add okhp3/skillz/oo-component-documentation@sha256:27716aa29ebc98e0The line at the top of this page pins the label git:20260828.866dec6, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_x3hromujuzti7w2r)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Aug 28, 2026.
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (5384 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
okhp3/skillz · 3 stars · license MIT · pushed 2026-11-06 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_x3hromujuzti7w2r GET https://markdownregistry.com/api/v1/resolve?ref=okhp3/skillz/oo-component-documentation GET https://markdownregistry.com/api/v1/blob/27716aa29ebc98e0b21c2f09e6694eecf1449896cc1070e2460fe5d4285357cc
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.