Resources · Docs
Documentation.
Setup walkthroughs, workflow guides, and reference material. Search or filter by category to find what you need.
Quickstart: your first project
Spin up a workspace, create a project, import requirements, and see the trace canvas fill in — under 10 minutes.
Inviting your team
Roles, project membership, and how viewer/member/admin permissions work.
Requirements: types, statuses, versions
Understand RequirementType, the DRAFT → APPROVED lifecycle, version snapshots, and how change requests route.
Linking requirements to specifications
Create typed links, link to a specific SpecSection, and bulk-link from the matrix view.
Building a verification matrix
Connect TestCase records to requirements, track verification method, and read coverage rollups.
Trace Score explained
How the project Trace Score is calculated, which dimensions count, and what severity weighting means.
Uploading project documents
Supported formats (.docx, .pdf, .xlsx), chunking, and how the RAG retrieval pipeline scopes results per project.
Bring-your-own LLM keys
Add per-user OpenAI, Anthropic, or Vercel AI Gateway keys; manage server-side fallbacks.
Approving AI suggestions
Use Suggestions and Extractions review queues; understand PENDING → ACCEPTED/REJECTED/DISMISSED, activity logging, and human review gates.
Products/components BOM table-tree
Read the Products / Components Structure view: collapse hierarchy, spec-gap chips, make/model fields, readiness rollups, and leaf status pills.
Schedule import (MS Project XML)
Map MS Project tasks onto TraceWorks tasks; keep linked artifacts in sync after re-import.
Submittal review cycles
Configure review gates, capture sign-off records, and produce a submittal log report.
Data model reference
All 60+ Prisma models, link tables, and enums — what each field is for and how relationships flow.
MCP server: connect Claude, Cursor, and other AI clients
TraceWorks exposes a Model Context Protocol endpoint secured by OAuth 2.1. Use 52 scoped tools to list projects, fetch requirements, create records, link trace artifacts, inspect Trace Score, or run RAG retrieval.
14 of 14 docs shown.
Can't find what you need?
We're actively expanding the docs. Tell us what's missing and we'll prioritize it.
Request a doc