Learn

Use Learn to understand and apply the system. Use Standards when you need the governing contract.

Terminology Model

The core Cuddler terms and how they relate to one another in the publication hierarchy.

Vocabulary map

How the core terms group together

The terms make more sense when you see them as distinct layers rather than one blended idea.

Governing standardsDocument Role and Artifact Specification

These define the role-specific rules and the shared authoring model.

Artifact familyArtifact Definition

This is the definition document for one specific artifact type.

Implemented instanceArtifact Document

This is the concrete artifact produced or rendered under the governing contracts.

Input contractData Schema

Validates the data JSON before rendering begins.

Render contractTemplate Schema

Validates the markdown-template JSON separately from the data contract.

Final outputReport

The finished HTML output that appears only after both validations succeed.

Precise language keeps the workflow understandable for both people and tools.

Cuddler works best when the language stays precise. The public model uses a small set of terms that map to different responsibilities in the publication and rendering workflow.

Core terms

  • Document Role: the job an artifact plays in the system. Today the public roles are Data, Template, and Process.
  • Document Role Specification: the governing standard for one document role. It tells you what additional rules apply when an artifact’s role is Data, Template, or Process.
  • Artifact Specification: the shared standard for authoring public Artifact Definitions.
  • Artifact Definition: the definition document for a specific artifact type.
  • Artifact Document: the actual implemented artifact that is produced or rendered from the governed contract.
  • Data Schema: the schema used to validate data JSON before rendering.
  • Template Schema: the schema used to validate markdown-compliant template-document JSON separately from the data.
  • Report: the final HTML output produced after validation succeeds and rendering is allowed to proceed.

Why the terms matter

These terms are not interchangeable. A Document Role answers “what is this artifact for?” The Artifact Specification answers “what shared authoring rules apply?” The Artifact Definition answers “what exact artifact type is this?” Keeping those boundaries visible makes the model easier to explain, validate, and implement.