Annotations

Annotations are an optional, advanced feature used to highlight specific moments, provide additional context, or flag areas for review that don't fit directly into a step's description.

Optional feature. Only generated when explicitly requested or when specific callouts are needed.

The Annotation object

  • Name
    id
    Type
    string
    Description

    A unique identifier for the annotation.

  • Name
    targetId
    Type
    string
    Description

    The ID of the Phase or Step this annotation refers to.

  • Name
    note
    Type
    string
    Description

    The content of the annotation.

  • Name
    category
    Type
    string
    Description

    Optional category (e.g., "Review", "Warning", "Idea").

Was this page helpful?