Docs Module Ref
Write reference documentation for a module containing multiple related data types. Use when documenting a cohesive domain model (e.g. http-model, resource-management) where types work together as a system.
Install
$ agentstack add skill-zio-zio-skills-docs-module-ref ✓ scanned · ✓ verified, works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ✓ Environment & secrets No
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
Verified badge
Passed review? Show it. Paste this badge into your README, it links to the public security report.
Links to your public security report.[](https://agentstack.voostack.com/security/report/skill-zio-zio-skills-docs-module-ref) Reliability & compatibility
Declared compatibility
Compatibility is declared by the source manifest. End-to-end runtime verification is coming, see below.
We're building live execution health for every listing: tool-call success rate, median latency, uptime, and last-checked timestamps, measured, not self-reported. It isn't live yet, so we don't show numbers we can't stand behind.
How agent discovery & health will work →About
Module Reference: Conceptual Overview
A module reference documents a cohesive set of related data types that work together as a system. It is not a single data-type reference (which documents one type exhaustively) — it emphasizes how types compose and interact.
Core Properties
- Documents every public method on every core type
- "How They Work Together" is the centerpiece — never skip it; always includes ASCII diagram of type relationships and numbered workflow
- All code examples compile with zero mdoc errors
- Structure chosen by module shape — not arbitrary
Structure Rule
| Module shape | Structure | | ---------------------------------------------------------- | ------------------------------------------------------------------------------ | | ≤ 4 core types, or types always used together | Flat — single file at docs/reference/.md | | ≥ 5 core types, OR ≥ 3 types with rich self-contained APIs | Hierarchical — docs/reference//index.md + one page per type |
Decide before writing. State which structure and why.
Module-Level Sections (required)
- Opening Definition — NO heading, immediately after frontmatter; 1–3 sentences + core type list + plain
scalastructural shape - Introduction / Motivation — module role and problem solved
- Installation —
libraryDependenciessnippet - How They Work Together — ASCII diagram of type relationships + numbered workflow steps
- Common Patterns — multi-type composition examples, decision tree for choosing types
- Integration Points — intra-module relationships, ZIO ecosystem connections
Type-Level Sections
- Flat: inline
##heading per type — definition, predefined instances, construction, key operations, rendering - Hierarchical: full page per type following
docs-data-type-refconventions, plus a recontextualization note in each section linking back to sibling types
mdoc Conventions
- Method signatures: plain
scalablock (no mdoc) - Usage examples:
mdoc:resetblock - Setup + output in a single block — never split
- No blank lines between consecutive code blocks
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: zio
- Source: zio/zio-skills
- License: Apache-2.0
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet, be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.