一键在 Manus 中运行任何 Skill

docs-data-type-ref

星标4

分支1

更新时间2026年6月29日 14:16

Write reference documentation for a specific ZIO data type. Research the type, write comprehensive documentation with examples, verify mdoc compilation, and integrate into docs.

安装

用 Codex 或 Claude 帮你安装复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。

在 Manus 中运行

来源

zio

zio/zio-skills

打开 GitHub 仓库查看创作者相关仓库

下载

在 Manus 中运行

Data Type Reference: Conceptual Overview

A data type reference page is task-independent, comprehensive API documentation for a single ZIO type. It is not a tutorial (teaching concepts) or how-to guide (achieving a goal) — it documents everything about one type for practitioners who need authoritative API details.

Core Properties

Documents every public method on the type and its companion object
All code examples compile with zero mdoc errors
Precise section order — readers navigate by scanning headings, so sequence matters
No duplication — each method appears exactly once

Section Structure

Opening Definition — NO heading, immediately after frontmatter; type signature + key properties + plain scala structural shape
Motivation / Use Case (if applicable) — problem + why this type solves it
Quick Showcase — 1–3 examples in a single mdoc:reset block showing core capabilities
Installation (if applicable) — libraryDependencies for top-level module types
Construction / Creating Instances — all factory methods, smart constructors, conversions
Predefined Instances (if applicable) — variants, constants in a table or block
Core Operations — grouped methods: Element Access, Transformations, Combining, Querying, Conversion
Subtypes / Variants (if applicable) — when to use each, how to create, differing operations
Comparison (if applicable) — contrast with Java/Scala stdlib equivalents
Advanced Usage (if applicable) — composition with other types
Integration (high-confidence only) — only when non-trivial cross-module wiring with a runnable example
Running the Examples (when standalone examples exist)

mdoc Conventions

Method signatures: plain scala block (no mdoc)
Usage examples: mdoc:reset block
Setup + output in a single block — never split
No blank lines between consecutive code blocks

Quality Gate

Every method documented, zero mdoc compilation errors, frontmatter id matches filename.

同仓库更多 Skills

同仓库

docs-how-to-guide

zio/zio-skills

Write a how-to guide for practitioners accomplishing a specific task with a ZIO library. Guides are goal-oriented and task-focused, not pedagogical. Use when writing step-by-step practical guides.

2026-07-034

docs-tutorial

zio/zio-skills

Write a tutorial for newcomers learning a topic in a ZIO library. Tutorials teach concepts step-by-step in a linear path for learning-oriented, not task-oriented, purposes. Use when writing comprehensive learning guides.

2026-07-034

docs-mdoc-conventions

zio/zio-skills

Reference for mdoc code block modifiers and Docusaurus admonitions used in ZIO documentation. Use when writing or reviewing documentation with Scala code examples.

2026-07-014

docs-module-ref

zio/zio-skills

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.

2026-06-304

docs-integrate

zio/zio-skills

Integration checklist for new ZIO docs pages. Handles sidebar wiring, index.md linking, and compilation gate (mdoc + Docusaurus build). Cross-referencing is handled separately by the integrate workflow (Phase 2).

2026-06-274

docs-reduce-redundancy

zio/zio-skills

Remove redundant content from documentation. Use when sections repeat information unnecessarily, type definitions appear multiple times, concepts are introduced more than once, or transition words clutter meaning. Reduces cognitive load through deduplication and strategic cross-referencing.

2026-06-274

name	docs-data-type-ref
description	Write reference documentation for a specific ZIO data type. Research the type, write comprehensive documentation with examples, verify mdoc compilation, and integrate into docs.
tags	["documentation","data-type","reference","zio","agent-skills"]

Data Type Reference: Conceptual Overview

Core Properties

Documents every public method on the type and its companion object
All code examples compile with zero mdoc errors
Precise section order — readers navigate by scanning headings, so sequence matters
No duplication — each method appears exactly once

Section Structure

Opening Definition — NO heading, immediately after frontmatter; type signature + key properties + plain scala structural shape
Motivation / Use Case (if applicable) — problem + why this type solves it
Quick Showcase — 1–3 examples in a single mdoc:reset block showing core capabilities
Installation (if applicable) — libraryDependencies for top-level module types
Construction / Creating Instances — all factory methods, smart constructors, conversions
Predefined Instances (if applicable) — variants, constants in a table or block
Core Operations — grouped methods: Element Access, Transformations, Combining, Querying, Conversion
Subtypes / Variants (if applicable) — when to use each, how to create, differing operations
Comparison (if applicable) — contrast with Java/Scala stdlib equivalents
Advanced Usage (if applicable) — composition with other types
Integration (high-confidence only) — only when non-trivial cross-module wiring with a runnable example
Running the Examples (when standalone examples exist)

mdoc Conventions

Method signatures: plain scala block (no mdoc)
Usage examples: mdoc:reset block
Setup + output in a single block — never split
No blank lines between consecutive code blocks

Quality Gate

Every method documented, zero mdoc compilation errors, frontmatter id matches filename.