vistect.vercel.app

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "description": "The report title, as it should appear on the cover."
    },
    "purpose": {
      "type": "string",
      "minLength": 1,
      "description": "What this document is for, in one or two sentences. Required: every later recommendation is judged against it, and an empty purpose produces generic advice."
    },
    "audience": {
      "default": [],
      "description": "Who will read it, e.g. [\"funders\", \"local authority partners\"].",
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "primaryMessage": {
      "default": "",
      "description": "The one thing a reader should take away. Leave empty if it is not settled yet.",
      "type": "string"
    },
    "tone": {
      "default": [],
      "description": "e.g. [\"plain\", \"confident\", \"warm\"].",
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "avoid": {
      "default": [],
      "description": "Framings and imagery to stay away from. Pre-seeded with pity, charity and medical framing; add to it rather than replacing it.",
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "language": {
      "default": "en",
      "description": "BCP 47 language tag for the document.",
      "type": "string"
    },
    "pageTemplates": {
      "default": [
        "cover",
        "text-led"
      ],
      "description": "One id per starting page, in order. Available: cover, text-led, text-with-side-image, chart-page.",
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "cover",
          "text-led",
          "text-with-side-image",
          "chart-page"
        ]
      }
    }
  },
  "required": [
    "title",
    "purpose"
  ]
}