Menu

First 30 minutes

Verification Required

Tutorial standards for first-success workflows.

Every Stornamics tutorial starts with a concrete result, lists the setup needed to run safely, shows copy/paste commands with expected output, proves success, and ends with cleanup, troubleshooting, evidence, and limits.

Standards Snapshot

Required sections
12
First tutorials
5
Review gates
3

Available Setup Pages

  • Available: DOCS-021

    Local environment prerequisites

    Baseline required tools, optional helpers, and product-specific setup assumptions for local first-success tutorials.

Tutorial Contract

Prerequisites

Required

Separate required tools, product setup, environment values, and local assumptions before the reader starts.

Checks

  • Required tools include versions or detection commands.
  • Product-specific values name tenant, dataset, bucket, stream, queue, service binary, or data directory needs.
  • Optional helpers are clearly separated from required setup.

Copy/Paste Commands

Required

Commands must be runnable without shell prompts, hidden setup, or real credentials in the example.

Checks

  • Working directory is shown when it matters.
  • Repeated values use environment variables or all-caps placeholders.
  • Each state-changing command creates or updates only tutorial-scoped resources.

Expected Output

Required

Each important step shows exact output, response fields, or pattern guidance that proves the command worked.

Checks

  • Stable commands show exact text or HTTP status.
  • Dynamic IDs, timestamps, and ordering use field-focused output.
  • Readiness checks point to the line or response field the reader should inspect.

Success Criteria

Required

Every tutorial promises a concrete result and proves it with a final verification step.

Checks

  • ObjectDB workflows prove bucket or object state.
  • Message Broker workflows prove stream, replay, queue, or cursor state.
  • LogDB workflows prove accepted telemetry and queryable retained records.
  • Concordia workflows prove local Cache, Time Series, Gateway, or diagnostic behavior without broadening maturity.

Cleanup

Required

Cleanup is required unless the workflow leaves no persistent state, in which case the page says so explicitly.

Checks

  • Local services started by the tutorial are stopped.
  • Tutorial-created data is removed or scoped for safe reuse.
  • Cleanup commands avoid shared developer state.

Troubleshooting

Required

Troubleshooting entries should recover common first-run failures without expanding the product claim.

Checks

  • Missing tool, service start, port, auth, unsupported surface, and no-data failures are considered.
  • Each entry names how to recognize the problem.
  • Fixes stay minimal and point to limits, compatibility, or prerequisites when needed.

Smoke Coverage

Required

Tutorial source must declare whether smoke coverage is automated, semi-automated, or manual.

Checks

  • `tutorial_smoke` frontmatter names the smoke level and command when script-backed.
  • Automated and semi-automated coverage names the behaviors the command exercises.
  • Manual and semi-automated gaps include reviewer-run rationale.

Review Gates

Product SME

Required for product behavior

Accepts the exact commands, expected output, maturity label, limits, and product-specific wording.

Docs QA

Required for runnable workflows

Checks copy/paste behavior, expected output, success criteria, cleanup, and troubleshooting coverage.

Sensitive Review

Required when claims trigger it

Security, privacy, legal, support, operations, performance, scale, availability, or durability claims route through the existing claim-review workflow.

Planned First Tutorials

Review Model

Standard

Tutorial standards define the required sections, command rules, expected-output rules, cleanup rules, troubleshooting rules, and reviewer checklist.

Prerequisites

Prerequisite reviews define required tools, optional helpers, product-specific checks, and setup assumptions for first-success workflows.

Template

Quickstart templates keep product tutorials consistent while each product owns its exact commands and limits.

QA Automation

Automation checks smoke coverage metadata and reviewer-run rationale for tutorial examples before claims strengthen.