# ISIS v2 VFX Element Pack Operator/Creator Documentation with Troubleshooting

Generated: 2026-08-02T18:33:39.984Z Checklist: `MXA-0432` (ISIS2-00630) Asset
Family: `vfx-element-pack` Phase: Phase 4 | Milestone: M3 Launch (2026-07-27 to
2026-10-30)

## Objective

Publish creator and operator documentation with troubleshooting for
vfx-element-pack workflows, spanning workflow authoring, guardrail operations,
regression diagnostics, and downstream integration remediation.

## Persona Coverage

| Persona    | Workflow Focus                                              | Coverage Signals                |
| ---------- | ----------------------------------------------------------- | ------------------------------- |
| `creator`  | Workflow authoring, variant controls, typed submission      | controls=79, validationRules=42 |
| `operator` | Guardrails, regression, integration and runbook diagnostics | envKeys=15, troubleshooting=6   |

## Workflow Coverage

| Workflow                               | Creator UI Documentation | Operator Policy Documentation | Troubleshooting Coverage |
| -------------------------------------- | ------------------------ | ----------------------------- | ------------------------ |
| `vfx-element-pack-baseline`            | yes                      | yes                           | yes                      |
| `vfx-element-pack-image-conditioned`   | yes                      | yes                           | yes                      |
| `vfx-element-pack-control-conditioned` | yes                      | yes                           | yes                      |
| `vfx-element-pack-consistency-locked`  | yes                      | yes                           | yes                      |

## Troubleshooting Matrix

| Issue                                     | Signal                                              | Persona    | Source Coverage |
| ----------------------------------------- | --------------------------------------------------- | ---------- | --------------- |
| `creator-contract-validation-failure`     | `INVALID_WORKFLOW_RUN_REQUEST`                      | `creator`  | yes             |
| `budget-hard-limit-exceeded`              | `VFX_ELEMENT_PACK_BUDGET_GUARDRAIL_LIMIT_EXCEEDED`  | `operator` | yes             |
| `quality-gate-failed`                     | `VFX_ELEMENT_PACK_QUALITY_GATE_FAILED`              | `operator` | yes             |
| `regression-quality-drift`                | `regression-vfx-element-pack-quality-drift`         | `operator` | yes             |
| `regression-output-package-contract-miss` | `regression-vfx-element-pack-package-contract-miss` | `operator` | yes             |
| `downstream-trigger-integration-drift`    | `workflow-trigger-endpoint-mismatch`                | `operator` | yes             |

## Creator Quickstart

- Select the vfx-element-pack workflow variant that matches the shot intent and
  control profile.
- Complete required effect descriptors and conditional
  reference/control/continuity-lock fields before submit.
- Use side-by-side output comparison to verify silhouette stability, alpha-edge
  cleanliness, temporal coherence, and continuity-lock consistency before
  approval.
- Export to downstream engine or DCC targets using recipe metadata for
  asset-family traceability.

## Operator Diagnostics Surface

- `X-Vfx-Element-Pack-Estimated-Cost-Usd`
- `X-Vfx-Element-Pack-Budget-Guardrail-Mode`
- `X-Vfx-Element-Pack-Budget-Guardrail-Reason`
- `X-Vfx-Element-Pack-Quality-Gate-Mode`
- `X-Vfx-Element-Pack-Quality-Gate-Reason`
- `X-Vfx-Element-Pack-Quality-Failing-Metrics`

## Verification Commands

- `pnpm --filter @isis/web exec vitest run src/pages/vfx-element-pack-ui-utils.spec.ts src/pages/WorkflowDetailsPage.spec.tsx`
- `pnpm --filter @isis/generation-api exec vitest run src/routes/vfx-element-pack-budget-utils.spec.ts src/routes/vfx-element-pack-quality-gate-utils.spec.ts src/routes/vfx-element-pack-regression-golden-dataset.spec.ts`
- `pnpm --filter @isis/client exec vitest run src/examples/external-integrations.spec.ts src/examples/vfx-element-pack.spec.ts`

## Acceptance Criteria

- Creator documentation covers all vfx-element-pack workflow variants, required
  controls, validation constraints, and typed SDK run paths.
- Operator documentation covers budget and quality guardrail policies, required
  environment keys, regression diagnostics, and monitoring headers.
- Troubleshooting matrix includes creator-input, budget, quality, regression,
  and downstream integration remediation flows with concrete source
  traceability.
- Published documentation remains reproducible through generator/validator
  scripts and evidence-linked governance artifacts.

## Traceability

- Checklist item: `MXA-0432`
- Ticket key: `ISIS2-00630`
- Linked checklist dependencies: `MXA-0425`, `MXA-0426`, `MXA-0427`, `MXA-0428`,
  `MXA-0429`, `MXA-0430`, `MXA-0431`
