doc-yaml-schema

Name: doc-yaml-schema
Availability: InStock
Author: froide

Generate YAML design documents from JSON Schema and validate them against schemas.

1|Updated Mar 28, 2026

Search Tags:#documentation #validation #yaml #schemas #design-docs #json-schema

Ready to run

npx skills add https://github.com/froide-kk/michinushi --skill doc-yaml-schema

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-yaml-schema
Source: https://github.com/froide-kk/michinushi/tree/main/doc-yaml-schema
Command: npx skills add https://github.com/froide-kk/michinushi --skill doc-yaml-schema

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

JSON Schema の仕様を YAML 設計書に変換し、設計ドキュメントの生成と検証を自動化します。

Core Features & Use Cases

YAML 設計書の生成と検証を、JSON Schema との対応関係を保ちながら実行します。
マスタースキーマとプロジェクト固有スキーマの参照により、設計書の整合性を確保します。
Use Case: 大規模な API 設計で、要件定義・API仕様・デザインの各設計書を同一フォーマットで管理します。

Quick Start

Run the YAML design generator on a given JSON Schema to output the corresponding YAML document.

Frequently Asked Questions about doc-yaml-schema

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate YAML design documents from JSON Schema?▼

Generating YAML design documents from JSON Schema involves running a dedicated generator that transforms your schema specifications into structured YAML artifacts while preserving their hierarchical relationships.

What is the best way to validate YAML design docs against master and project schemas?▼

The best way to validate YAML design docs against master and project schemas is to use an automated validation process that enforces schema references and metadata embedding for structural consistency.

Can I manage requirements, domain models, and APIs in the same YAML format?▼

You can manage requirements, domain models, and APIs in the same YAML format by generating design documents from JSON Schema that cover workflows for architects, designers, and implementers comprehensively.

Does JSON Schema validation enforce schema references and metadata embedding in YAML?▼

Yes, JSON Schema validation enforces schema references, validation rules, and metadata embedding in YAML outputs to ensure that your design artifacts remain consistent and auditable across the entire project.

When do I need YAML design documents for API design?▼

You need YAML design documents for API design when managing large-scale projects that require consistent formatting across requirements definition, API specifications, and system architecture design artifacts.