Skip to content

Workflow — Guides generation

Generated from the architecture model

This page is rendered from model/**/*.yaml by tools/docs_model during mkdocs build. Edit the YAML, not this page; hand-written design lives on the linked service, platform and plane pages.
Workflow id guides-generation · version 1 · Draft (Draft → InReview → Published → Deprecated, BC-04)
Coordinator ai-assist-doc-generator · family Documentation & Knowledge Management
Owner service WorkflowEngineService (BC-38) under Run Control (BC-03)
Starts on GenerationCompleted from GenerationRecipeService (event)
Steps 4 · gated 0 · agents 1
Budget per run 600000 tokens · cap 60.0 USD · 240 min
Descriptor workflow-definition-v1 · schema
Status target

Drafts guides and tutorials for a generated product as artifacts for human review; nothing is published by the run.

Authored design, Draft (D54, D57)

These definitions were authored on 2026-10-14 from the coordinator cards as design assumptions. None is published, evaluated or has run; agents are named by id as design bindings, not as tested integrations.

Definition

flowchart TD
    start(("GenerationCompleted"))
    outline["Outline the guides"]
    draft["Draft the guides"]
    self_review["Review for accuracy"]
    store_drafts["Store the drafts"]
    start --> outline
    outline --> draft
    draft --> self_review
    self_review --> store_drafts
    done(("WorkflowRunCompleted"))
    store_drafts --> done
    classDef gated stroke:#B45309,stroke-width:2px
Hold "Alt" / "Option" to enable pan & zoom

Shapes: rectangle = agent attempt · double rectangle = tool call · stadium = human decision · diamond = condition evaluated by the engine · parallelogram = fan-out or join · circle = timer · cylinder = sub-workflow · flag = compensation. A thick amber border marks a gated step.

Steps

# Step Kind Runs Gate Class Depends on Retry Timeout Compensation What it does
1 Outline the guides
outline		 agent documentation-writer none read — exponential ×2 PT30M — Chooses the guides from the blueprint's audiences and the product's screens and APIs.
2 Draft the guides
draft		 agent documentation-writer none sandbox outline exponential ×2 PT30M — Writes each guide against the generated code with cited sources.
3 Review for accuracy
self-review		 agent documentation-writer none read draft exponential ×2 PT30M — Checks every statement against the sources; unverifiable statements are marked.
4 Store the drafts
store-drafts		 agent documentation-writer none sandbox self-review exponential ×2 PT30M — Stores the drafts as artifacts for human review; publication is a separate approval.

Gates and approvals

No approval is required: every step runs in the read or sandbox class; the agents' own tool calls still carry their classes (D21). Compensation steps run in reverse order of the succeeded steps on failure after the last checkpoint; a step without a compensation leaves its sandbox output in place and the run ends Failed with the evidence (ADR-0014, recovery not replay).

Inputs, outputs and events

Direction Name Descriptor
in documentation-blueprint blueprint-documentation-v1
in generated-outputs change-set-v1
out guide-drafts artifact-v1

Starts on GenerationCompleted; emits ArtifactStored, plus the engine's WorkflowRunStarted, StepReady, StepRunStateChanged and WorkflowRunCompleted / WorkflowRunFailed and Run Control's run and attempt events (ADR-0014).

Decisions and traceability

FR: FR-08 Validated artifacts with lineageFUX: FUX-12 Documented viewsADRs: ADR-0014, ADR-0024 · ADR index

Definition authored 2026-10-14 from the coordinator card ai-assist-doc-generator (D54); Draft until an evaluation gate (ADR-0021) and a review publish it as a BC-04 asset release.