Skip to main contentMeaningWhat the field is forDescribe the field's purpose in the document rather than leaving the name to do all the work.
ContentWhat belongs thereSay what kind of information the assistant or author should provide.
SpecificityHow detailed to beSet the expected depth so the output does not drift between vague and overlong.
GuardrailWhat to avoidCall out common failure modes that make the field ambiguous or misleading.
Good property guidance reduces ambiguity at the source instead of during review.
This is one of the core Cuddler patterns: do not rely on a field name alone to explain what belongs in that field.
Pattern
For each important property, describe:
- what the field means
- what kind of content belongs there
- how specific the assistant should be
- what to avoid
Why It Helps
- It reduces ambiguity for both humans and AI systems.
- It keeps schema authors honest about the actual intent of a property.
- It makes the resulting documents easier to validate and review.
Use This When
- the document will be generated or assisted by AI
- the field matters to downstream rendering or review
- a vague description would cause avoidable cleanup later
