api-docs
/api-docs
Document a module or public API surface (functions, classes, CLI commands, endpoints) from the code itself. Use when the user asks for API reference, to document a module, or to write usage docs for a public interface.
- Author
- omnigent-ai ↗
- Repository
- omnigent ↗
- Licence
- Apache-2.0
- Last repository change
- 27.10.2026
Assessment and security
- Files in this package
- 1
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 27.10.2026, without references to retired models or APIs.
Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.
What it does and when to use it
Document a module or public API surface (functions, classes, CLI commands, endpoints) from the code itself. Use when the user asks for API reference, to document a module, or to write usage docs for a public interface.
Original author description
Document a module or public API surface (functions, classes, CLI commands, endpoints) from the code itself. Use when the user asks for API reference, to document a module, or to write usage docs for a public interface.
How it works
- Read the surface
- Structure
- Write the entries
- Verify
SKILL.md preview
---
name: api-docs
description: Document a module or public API surface (functions, classes, CLI commands, endpoints) from the code itself. Use when the user asks for API reference, to document a module, or to write usage docs for a public interface.
---
# api-docs — document a public API surface from the code
Produce reference docs that match the code exactly, derived from the source, not
from assumptions about what the API "probably" does.
## Read the surface
Identify the public surface to document (a module, class, CLI command group, or
set of endpoints). Then have the researcher read it carefully:
- Dispatch the researcher (`purpose: explore`) to enumerate the public
entry points and report each one's real signature, parameters, defaults,
return shape, and raised errors — with file:line evidence.
- Prefer what the code declares (signatures, type hints, docstrings, default
values) over prose descriptions. Public vs. private follows the project's
convention (e.g. a leading underscore, or an `__all__` / export list).
## Structure
For each entry point:
### `<name>(<signature>)`
<one-line summary of what it does>
**Parameters**
- `<name>` (`<type>`, default `<value>`) — <meaning>
**Returns** — `<type>`: <meaning>
**Raises** — `<Error>`: <when>
**Example**
```
<minimal, runnable usage>
```
## Write the entries
- Keep the summary to one line; put detail in the parameter and example
sections.
- Document every public parameter, including defaults, in the order they appear
in the signature.
- Give one minimal example per entry point that actually runs against the
documented signature.
- Do not document private/internal helpers unless the user asks; a reference is
the contract, not a code tour.
## Verify
Signatures, defaults, and error types drift fastest, so route the finished
reference through the `reviewer` (`purpose: review`) to confirm every signature
and default matches the current code.
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · omnigent-ai/omnigent | 100 | Apache-2.0 |
| mono/SkiaSharp | 100 | MIT |
| Kuan-AI-com/agent-skills | 100 | MIT |
| meyshad/skillforge | 100 | MIT |
| Sun-Lab-NBB/ataraxis | 100 | Apache-2.0 |
| zjunlp/skills | 100 | MIT |
Identical content appears in 1 other GitHub folders. We show one copy with the highest score.
Database snapshot: 13.11.2026 · package version 08161732ba40 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100api-documentation
Documents an interface others will call — endpoints, SDK methods, CLI commands, and their parameters, errors, and limits. Use this whenever the user needs API docs, an OpenAPI spec, reference documentation, docstrings for a public library, or has an interface that people keep… - 100update-docs
Update public documentation in docs/public/ when features or tools change. Triggers on "/update-docs", "update docs", "update documentation". - 100document-generate
Use when a feature, module, or whole project needs missing documentation created from scratch - read the codebase, map the public surface with Diataxis (tutorial/how-to/reference/explanation), and generate the missing docs with cross-links. - 100write-docs
Generate documentation for custom elements based on their manifest data. Use when the user asks to "write docs", "generate documentation", "document this element", "create API docs", or mentions "usage examples" or "component documentation". - 100api-documentation
Document an existing or proposed HTTP API for its actual consumers. Use when creating API reference docs, examples, authentication guidance, or migration notes. - 100api-design
Designs an interface other people will depend on — REST endpoints, RPC methods, library functions, CLI commands, event payloads. Use this whenever the user is adding a public endpoint, designing a library's surface, defining a message contract, or asking how something should be…