Getting Started
Upload requirements
Ingest specifications and requirements to drive governed test generation.
Overview
Requirements drive governed test generation and coverage traceability. Zof accepts requirements through two primary paths: attachment during project creation, or managed specification records in the Specifications area.
Higher-quality requirements, with numbered acceptance criteria, edge cases, and measurable outcomes, produce more actionable scenarios and cases. Vague bullet lists often require substantial human editing after generation.
Who should read this
- QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.
Prerequisites
- Project or specification creation permission
- Document in PDF, DOC, DOCX, PNG, or JPG format
- Stable network for upload (10MB limit per typical project upload)
When to use this workflow
- Onboarding new team members to Zof terminology and workflows
- Authoring internal runbooks aligned with Console labels
- Designing CI/CD or webhook integrations against documented behavior
Step-by-step procedure
Choose upload path
Project wizard: attach during Create project for immediate generation context.
Specifications: Platform → Specifications → Add specification for org-wide catalog and traceability.
Prepare the document
Structure requirements with IDs or headings for traceability (REQ-001, US-142).
Include acceptance criteria, error cases, and non-functional requirements where relevant.
Upload and confirm
Drag and drop or browse to select the file; wait for upload confirmation toast.
Verify the document appears in project attachments or specification list.
Link to coverage (Specifications path)
Open Quality → Coverage to map requirement records to generated or authored cases.
Address gaps before release gate evaluation.
Key concepts
- Organization scope
- All Zof Console and API operations are isolated to your authenticated tenant.
- Governed execution
- Agent output and remediation follow policy packs with human approval when configured.
Best practices
- Validate changes in staging before applying release gates to production.
- Include run IDs and timestamps when escalating issues to support or auditors.
- Align internal runbook terminology with Zof Console UI labels for clarity.
Common issues
- Upload fails
- Check file size and MIME type; retry on stable network; contact admin if storage quota exceeded.
- Generation ignores content
- Ensure document is attached to the correct project; allow processing time before triggering generation.
Was this page helpful?
