ワンクリックでManusで任意のスキルを実行

docs-module-ref

スター4

フォーク1

更新日2026年6月30日 14:37

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.

インストール

Codex または Claude でインストールこの Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。

Manusで実行

ソース

zio

zio/zio-skills

GitHub リポジトリを開く Creator のリポジトリを見る

ダウンロード

Manusで実行

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/<module-name>.md`
≥ 5 core types, OR ≥ 3 types with rich self-contained APIs	Hierarchical — `docs/reference/<module-name>/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 scala structural shape
Introduction / Motivation — module role and problem solved
Installation — libraryDependencies snippet
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-ref conventions, plus a recontextualization note in each section linking back to sibling types

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

このリポジトリの他の 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-data-type-ref

zio/zio-skills

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

2026-06-294

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

Module Reference: Conceptual Overview

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/<module-name>.md

≥ 5 core types, OR ≥ 3 types with rich self-contained APIs

Hierarchical — docs/reference/<module-name>/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 scala structural shape

Introduction / Motivation — module role and problem solved

Installation — libraryDependencies snippet

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-ref conventions, plus a recontextualization note in each section linking back to sibling types

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

name	docs-module-ref
description	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.
tags	["documentation","module","reference","zio","agent-skills"]