Help & Step-by-Step Guide
Everything you need to run a project in RequirementsHub.
This is the full user guide — every screen, every workflow, every output. If something is missing or unclear, email hello@requirementshub.ai.
01
How RequirementsHub works
RequirementsHub is a structured workspace for business analysis. You and your team capture the moving parts of a project — objectives, stakeholders, requirements, risks, systems, decisions, constraints — and the platform analyzes that knowledge model against BABOK, SAFe, and Lean Six Sigma practice to surface gaps, broken traceability, and missing artifacts.
It's like having a senior Business Analyst sitting beside your team: every finding is grounded in your real entities and points to the exact rule or technique it came from.
- 01
Sign in
Magic-link email — no password to manage.
- 02
Create or join a workspace
Workspaces are how teams collaborate. Owners invite members by email.
- 03
Create a project
Each project has its own objectives, stakeholders, requirements, risks, systems, decisions, and constraints.
- 04
Capture or import context
Add entities directly, or upload documents (BRDs, transcripts, decision logs) to extract them.
- 05
Link entities
Requirements link to objectives they support, risks they mitigate, and systems they touch — with typed relationships.
- 06
Run Intelligence
The analyzer scores readiness, surfaces gap findings, and produces a repair plan.
- 07
Coach & generate
On paid tiers, run Coaching activities and BA Techniques to produce real deliverables.
- 08
Export & share
Download the report, evidence trails, scorecards, and generated artifacts.
02
Getting started: sign in & first workspace
Sign in
- 01
Go to sign-in
Open /sign-in and enter your work email.
- 02
Click the magic link
We email you a one-time link. Click it from the same device. No password to remember.
- 03
Land on your account
You'll arrive on /workspaces. If you have no workspaces yet, you'll be prompted to create one.
Create your first workspace
- 01
Open Workspaces
Go to /workspaces.
- 02
Click ‘New workspace’
Give it a name that maps to your team or program — e.g. ‘Payments Modernization’ or ‘Acme Internal BA Team’.
- 03
Invite teammates (optional)
Add member emails now or later. Invitees are automatically added as members the moment you send the invite — they see the workspace as soon as they sign in.
Try the demo project
New accounts get a fully populated Payment Portal Modernizationdemo project so you can explore the report, findings, and exports without uploading anything first.
03
Workspaces, members & invitations
What a workspace is
A workspace is the container for everything your team works on: projects, members, shared decisions, and the audit trail of who did what. Each member sees every project in the workspace.
Invite a member
- 01
Open the workspace
Click your workspace name from /workspaces.
- 02
Open ‘Members’
From the workspace sidebar, choose Members.
- 03
Click ‘Invite’ and enter an email
Pick a role (Owner, Editor, Viewer). Owners can invite and remove others; Editors can change project data; Viewers are read-only.
- 04
Send
We email the invitee a link. They're added as a member immediately — if they already have an account, the workspace shows up the next time they sign in. New users are added on sign-up.
Revoke an invite or remove a member
- Open Members → click the row → ‘Revoke invite’ (pending) or ‘Remove member’ (active).
- Removing a member does not delete anything they created — entities stay with the workspace.
Why auto-membership
Invitees are added to the workspace the moment you invite them so that there's never a gap where ‘the email exists but the workspace is invisible’. You can always revoke or remove later.
04
Creating & structuring a project
Create a project
- 01
Open the workspace
From /workspaces, choose the workspace.
- 02
Click ‘New project’
Name it after the initiative, not the team — e.g. ‘Payment Portal Modernization’.
- 03
Set the stage
Pick the current BA stage: Discovery, Elicitation, Analysis, Solution Design, or Delivery Readiness. The analyzer adapts its checks to the stage.
What lives inside a project
- Objectives
- Measurable goals the project is trying to achieve.
- Stakeholders
- People and groups with authority, interest, or impact.
- Requirements
- What needs to be true — business, functional, technical, quality, shared, etc.
- Risks
- Things that could go wrong, with severity and likelihood.
- Systems
- Applications, integrations, and data stores in scope.
- Decisions
- What was decided, by whom, when, and why.
- Constraints
- Limits — regulatory, technical, budgetary, time-based.
- Artifacts
- Generated deliverables from BA Techniques and Coaching.
The project sidebar
Every project has a left-hand sidebar with one tab per entity type plus Activity (audit log) and Intelligence(the analysis report). Switch tabs freely — your work is auto-saved.
05
Capturing objectives, stakeholders & decisions
Add an objective
- 01
Open Objectives
From the project sidebar.
- 02
Click ‘New objective’
Give it a short title and a measurable outcome. The analyzer flags objectives that have no measure.
- 03
Link supporting requirements
Open the objective → ‘Supported by’ → add requirements. Unlinked objectives surface as orphaned_objective findings.
Add a stakeholder
- 01
Open Stakeholders
From the project sidebar.
- 02
Add name, role, and authority
Authority is used to detect missing decision-makers and to power the stakeholder map.
- 03
Tag ‘missing voice’ if needed
If you know a role should be represented but isn't, add a placeholder stakeholder so the gap is explicit.
Log a decision
- Open Decisions → ‘New decision’.
- Record: what was decided, who decided it, when, and the rationale.
- Link the decision to the requirements, risks, or objectives it affects so traceability is preserved.
06
Writing requirements with risk & system links
Add a requirement
- 01
Open Requirements
From the project sidebar.
- 02
Click ‘New requirement’
Pick a type: Business (BR), Functional (FR), Non-Functional (NFR), Technical (TR), Quality (QR), Shared (SHR), or Compliance.
- 03
Write a clear statement
Use ‘The system shall …’ phrasing. Add acceptance criteria — the analyzer flags requirements without them at Delivery Readiness.
- 04
Link supports / risks / systems
Use the context picker to attach objectives, risks, and systems. Each link captures a typed relationship — see next section.
The Requirement Context Picker
When you link a risk or system to a requirement, the picker now asks you to pick a relationship type. This is what feeds the intelligence report — vague links produce vague findings.
Risk relationship types
- Mitigates
- The requirement reduces the likelihood or impact of the risk.
- Introduces
- Implementing the requirement creates or amplifies the risk.
- Affected By
- The requirement is exposed to the risk if it materializes, but doesn't change it.
System interaction types
- Reads From
- The requirement consumes data from the system.
- Writes To
- The requirement sends data to the system.
- Integrates With
- Two-way integration or API exchange.
- Replaces
- The requirement replaces or retires the system.
- Depends On
- The requirement relies on the system being available and functioning at runtime.
- Extends
- The requirement adds new capability to an existing system without replacing it.
Why this matters
Relationship types are what let the analyzer say something specific like ‘TR-001 replaces Legacy Gateway but no migration objective exists’ instead of a generic ‘this requirement touches a system’ statement.
07
Risks, systems & relationship metadata
Add a risk
- Open Risks → ‘New risk’. Give it an ID like RSK-001 and a short title.
- Set severity (Low / Medium / High / Critical) and likelihood.
- Add a mitigation owner if known. Risks without mitigating requirements are flagged.
Add a system
- Open Systems → ‘New system’. Give it an ID like SYS-001 and a short description (purpose, vendor, status).
- Mark it as in-scope or supporting. Systems with no requirement linking to them surface as a system_coverage finding.
Edit a relationship type
- 01
Open the requirement
From the Requirements tab, click the row.
- 02
Open the linked risk or system
Scroll to the ‘Risks’ or ‘Systems’ section.
- 03
Change the type inline
The dropdown next to each link is editable — pick a new type and it saves immediately.
08
Running the Intelligence analysis
Run an analysis
- 01
Open the project
From the workspace.
- 02
Click ‘Intelligence’ in the sidebar
Or visit the Intelligence tab directly.
- 03
Click ‘Run analysis’
The analyzer reads every entity and edge in the project and produces findings, scores, and a repair plan in seconds.
- 04
Re-run any time
Free includes one analysis per project. Pro includes unlimited re-runs — useful after adding entities or fixing findings.
What the analyzer checks
- Traceability — every requirement supports an objective; every objective has supporting requirements.
- Coverage — every in-scope system is touched by a requirement; every risk has at least one mitigating requirement.
- Quality — requirements are SMART and have acceptance criteria when the stage demands it.
- Authority — decisions have owners; stakeholders cover the required roles.
- Stage-fit — the artifacts present match what's expected at the project's current stage.
Stage matters
Some findings only fire at certain stages. For example, missing acceptance criteria is only flagged at Delivery Readiness — earlier stages don't yet expect them. Set your stage accurately or the findings will mislead you.
09
Reading findings & the repair plan
Where findings live
Findings appear on the project's Intelligence tab, grouped by severity (Critical → High → Medium → Low). Each finding shows the rule it came from, the entity it points to, why it matters, and the recommended next action.
Common finding types
- orphaned_objective
- An objective with no supporting requirements.
- untraced_requirement
- A requirement that doesn't support any objective.
- system_coverage
- An in-scope system that no requirement touches.
- missing_acceptance_criteria
- A requirement at Delivery Readiness with no acceptance criteria.
- missing_owner
- An entity that lacks an accountable owner.
- risk_without_mitigation
- A high/critical risk with no mitigating requirement.
- decision_without_rationale
- A logged decision missing its ‘why’.
The repair plan
The repair plan turns findings into ordered, sized actions grounded in BABOK knowledge areas, SAFe artifacts (Epic, Feature, Story, BDD, PI, DoD), or Lean Six Sigma tools (VOC, SIPOC, CTQ, DMAIC). Each action names a stakeholder, system, objective, or gap from your project — never a generic template.
10
Coaching, BA Techniques & deliverables
Project Coaching Workspace
Coaching takes a finding and walks you through resolving it: what to do next, who to involve, and what artifact to produce. Each activity is grounded in BABOK, SAFe, or Lean Six Sigma and scoped to your project's current stage.
BA Techniques
A library of applied techniques — SIPOC, CTQ trees, stakeholder maps, RACI, BDD acceptance criteria, story slicing, traceability matrices, and more. Run any technique against your project and we generate a deliverable pre-filled with your real entities, evidence, and gaps rather than a blank template.
How to run one
- 01
Open Intelligence
From the project sidebar.
- 02
Open the side panel
Choose Coaching or BA Techniques.
- 03
Pick an activity
We suggest the most relevant ones first, based on your current findings.
- 04
Generate
The output appears under the project's Artifacts tab, ready to download or hand off.
11
Exports, downloads & sharing
- Full report PDF — full formatted report with findings and scorecards.
- Evidence trail — per-finding source citations.
- Scorecards export — per-discipline grades.
- Repair plan export — actions sized for your tracker.
- Generated deliverables — outputs from BA Techniques and Coaching.
- Raw data export (ZIP) — all entities and findings as JSON.
Sharing
Reports are private to your workspace. Share by exporting the PDF, or invite a teammate to the workspace so they see the live report. Public sharing links are not enabled by default.
12
Errors & troubleshooting
- Invite link shows ‘invalid token’
- The invite has been revoked or has expired. Ask the workspace owner to re-send.
- Workspace not showing after sign-in
- Sign out and back in once — workspace membership is hydrated on session start.
- Upload failed: file too large
- Split or compress the file under 20 MB.
- Unsupported format
- Re-export to PDF, DOCX, or TXT and re-upload.
- No text extracted from a PDF
- Likely a low-quality scan. Re-scan at 300 DPI or paste text into a TXT file.
- Password-protected PDF
- Remove the password and re-upload.
- Analysis ‘stuck’
- Refresh the Intelligence tab. If still pending after a few minutes, re-run.
- Findings look thin
- Add more entities (or upload more source documents) and re-run. The analyzer can only reason about what's in the model.
- Payment didn't unlock
- Wait 30 seconds and refresh; if not resolved, contact support with your receipt.
For anything not listed, email hello@requirementshub.ai with your workspace, project name, and the screen you were on.
13
Plans & pricing
Free vs. Pro
Free covers workspace foundations — capture requirements, invite collaborators, and run one Intelligence analysis per project. Pro unlocks unlimited projects, unlimited re-analysis, the full Project Coaching Workspace, BA Techniques, and generated deliverables across your whole portfolio.
The two tiers
- RequirementsHub Free — $0
- Workspace, collaborators, full requirements repository, stakeholder map, decision log, one Intelligence analysis per project.
- RequirementsHub Pro — $29/month
- Everything in Free, plus unlimited projects, unlimited re-analysis, full Coaching Workspace, BA Techniques, generated deliverables, and Knowledge Model version history.
See current pricing on the Pricing page. Payment is via Stripe; receipts are emailed automatically. For invoices or VAT details, contact hello@requirementshub.ai.
14
Managing your data & account
You own everything you create
- Your workspaces, projects, entities, and reports are private to your account and workspace members.
- We do not train models on your content.
- Every action below is self-service — no tickets, no waiting.
Export everything
- 01
Open the Data Control Center
Go to /account/data.
- 02
Click ‘Export Everything’
We package every workspace and project you own — metadata, entities, relationships, findings, scores, and artifacts — into a single ZIP.
- 03
Save the ZIP
Browser downloads requirementshub-export-YYYY-MM-DD.zip. One folder per project, plain JSON files inside.
Delete a single project
- 01
Open Data Control Center
Scroll to ‘Delete a Project’.
- 02
Click ‘Delete’ on the project
A confirmation dialog opens with the exact project name.
- 03
Type the project name
‘Delete Permanently’ only activates on an exact match.
- 04
Confirm
We remove the project, every entity, every relationship, every finding, and any generated artifact. Irreversible.
Delete your account
- 01
Export first (recommended)
After deletion there is nothing to restore.
- 02
Open ‘Delete My Account’
On /account/data, scroll to the red card.
- 03
Type DELETE
Type
DELETEin uppercase. The final button only activates on an exact match. - 04
What gets removed
Every workspace you own, every project, document, entity, finding, score, generated artifact, and your account profile. Any active subscription is cancelled.
Quick reference
- Sign in
- /sign-in
- View workspaces
- /workspaces
- Account home
- /account
- View a project
- Open a workspace → choose a project
- Run analysis
- Project → Intelligence tab → Run analysis
- Download report PDF
- Intelligence tab → Export
- Export all raw data (ZIP)
- /account/data → Export Everything
- Delete a project
- /account/data → Delete a Project
- Delete account & all data
- /account/data → Delete My Account
Privacy & security
Visit the Trust Center for our Privacy Policy, Security, Data Handling, Subprocessors, DPA, and Incident Response details.
Still stuck?
Email hello@requirementshub.ai with your workspace, project name, and a short description. We typically reply within one business day.