Guides

How-to guides

Task-oriented guides for common Console workflows.

Overview

Task-oriented how-to guides for common Zof Console workflows. Each guide includes prerequisites, numbered steps with Console navigation paths, verification checkpoints, and expected outcomes.

Guides complement tutorials (multi-hour lessons) and detailed Console documentation (deep feature reference). Follow a learning path below for role-based onboarding, or jump to a single guide for a specific task.

Learning paths

  • New to Zof (Engineers and QA leads onboarding to Zof Console). Outcome: Complete first project, run validation, and read results in under one day. Start: Platform overview.
  • Engineering team setup (Platform and application engineering leads). Outcome: Register applications, wire CI, and standardize staging validation. Start: Add application.
  • QA team setup (QA engineers and test leads). Outcome: Govern test generation, suites, Test Health, and release readiness. Start: Upload requirements.
  • Security team setup (Security engineers and GRC partners). Outcome: Align RBAC, audit exports, and secure CI usage with organizational policy. Start: Authentication.
  • CI/CD setup (DevOps and release engineers). Outcome: Enforce PR and deploy gates with CLI or API. Start: CLI overview.
  • API integration (Backend engineers building internal tooling). Outcome: Authenticated REST automation with error handling and pagination. Start: API overview.
  • SDK integration (Application developers preferring typed clients). Outcome: Install SDK, run smoke validation, handle retries in CI. Start: SDK overview.
  • Enterprise rollout (Directors of engineering and enterprise architects). Outcome: SSO, RBAC, audit, and quota planning for multi-team adoption. Start: Administration.
  • Governed remediation (Release managers and SREs adopting safe auto-fix workflows). Outcome: Configure approval queues, verification runs, and audit evidence. Start: Governed remediation concept.
  • Agent catalog adoption (QA and platform teams expanding validation coverage). Outcome: Enable agent categories aligned to risk and review outputs before gates. Start: Agents overview.

Browse learning paths

New to Zof

Engineers and QA leads onboarding to Zof Console · Complete first project, run validation, and read results in under one day

Engineering team setup

Platform and application engineering leads · Register applications, wire CI, and standardize staging validation

QA team setup

QA engineers and test leads · Govern test generation, suites, Test Health, and release readiness

Security team setup

Security engineers and GRC partners · Align RBAC, audit exports, and secure CI usage with organizational policy

CI/CD setup

DevOps and release engineers · Enforce PR and deploy gates with CLI or API

API integration

Backend engineers building internal tooling · Authenticated REST automation with error handling and pagination

SDK integration

Application developers preferring typed clients · Install SDK, run smoke validation, handle retries in CI

Enterprise rollout

Directors of engineering and enterprise architects · SSO, RBAC, audit, and quota planning for multi-team adoption

Governed remediation

Release managers and SREs adopting safe auto-fix workflows · Configure approval queues, verification runs, and audit evidence

Agent catalog adoption

QA and platform teams expanding validation coverage · Enable agent categories aligned to risk and review outputs before gates

All how-to guides

Create your first project

Create a new project in the Zof Console to organize requirements, tests, runs, and results.

Add an application

Register a system under test with team ownership and environment metadata.

Upload requirements

Attach a PRD or specification to drive governed test generation.

Generate test scenarios

Produce AI-assisted scenarios from requirements after selecting test types.

Review generated test cases

Human validation of AI-generated cases before execution.

Edit a test case

Update steps, expected results, or metadata for an existing case.

Organize tests into suites

Group cases for batch execution and regression workflows.

Run your first test

Trigger validation execution from the Console.

Rerun a failed test

Re-execute a failed validation after fixes or environment correction.

Review test results

Interpret pass/fail states and operational metrics from run detail.

Debug a failed test

Use logs, timeline, and artifacts to diagnose failures.

Invite a team member

Expand organization access for colleagues.

Change a user role

Update RBAC assignments for organization members.

Configure organization settings

Set tenant defaults and operational preferences.

Configure project settings

Update project metadata, linked application, and operational context.

Connect a GitHub repository

Link source control for CI-triggered validation.

Configure CI/CD

Trigger governed validation from your deployment pipeline.

Add a web application

Register a URL-based system under test.

Add a desktop application

Register endpoint applications for Agent Console execution.

Configure endpoint agents

Register and policy-target execution agents on customer infrastructure.

View agent telemetry

Monitor agent health, connectivity, and operational metrics.

Use Demo Mode

View sample tenant data for internal demonstrations without affecting production.

Export a report

Download or share reliability reports with stakeholders.

Manage billing

Review plans, credits, and subscription status.

Set up notifications

Configure alert routing for runs, failures, and governance events.

Troubleshoot file upload

Resolve requirements upload failures.

Troubleshoot test generation

Resolve empty or stalled scenario and case generation.

Troubleshoot test execution

Diagnose run failures caused by infrastructure or connectivity.

Interpret reliability reports

Read reports metrics for operational and release decisions.

Approve remediation

Complete human authorization gate for governed fix plans.

Configure governance policies

Set policy packs and gates for execution and remediation.

Use Topology (System Graph)

Navigate dependency graph for impact and coverage analysis.

Use Zof Studio

Start a governed workspace session for asset authoring.

Add an integration

Connect an external provider to the Console.

Manage test artifacts

Access logs, screenshots, traces, and exports from completed runs.

Compare test runs

Perform regression analysis across two or more runs.

Create a regression suite

Build a suite from library cases for repeat validation.

Run tests before release

Execute release gate workflow before shipping.

Onboard a new QA engineer

Configure role and persona for QA team member.

Onboard a new organization

Complete tenant setup via onboarding wizard.

Use the Console as an admin

Tour Admin Center and platform configuration surfaces.

Use the Console as a test engineer

Focus on Quality and Operate sections for daily workflows.

Schedule recurring test runs

Configure cron schedules for continuous validation.

Map requirements to tests

Use coverage traceability to link requirements and cases.

Enable an AI testing agent

Toggle catalog agents for your organization.

Launch test from Agent Console

Execute validation via cloud or endpoint agents.

Quarantine a flaky test

Isolate unstable cases via Test Health quarantine workflow.

Configure release gates

Set quality checkpoints on Releases before ship.

Share results via link

Generate time-limited share links for run results.

Use command palette navigation

Navigate Console quickly with keyboard-driven search.

Was this page helpful?

How-to guides | Zof AI Documentation