Help & Guide
Everything you need to get value from RequirementsHub.
This guide walks you from your first upload to interpreting findings, downloading outputs, and managing your account and data. If you get stuck, email hello@requirementshub.ai.
01
How it works, end to end
RequirementsHub reads the documents you already have for a project — BRDs, PRDs, user stories, meeting notes, transcripts, emails — extracts the underlying objectives, stakeholders, requirements, risks, and constraints, then evaluates that knowledge model for gaps, contradictions, and broken traceability.
- 01
Sign in
Magic link by email — no password to manage.
- 02
Choose a plan
One-time Requirements Intelligence Report ($19) or Report+ ($49) per project, or a Pro / Consultant subscription for unlimited projects.
- 03
Upload documents
Drop in everything you have for that one project.
- 04
Automated analysis
Extraction → entity model → gap detection → scorecards.
- 05
Read your report
Findings with source evidence on every claim, plus Report Scorecards across BABOK knowledge areas.
- 06
Coach & generate
On Report+, Pro and Consultant: run Project Coaching activities and apply BA Techniques to produce deliverables.
- 07
Export & share
Download the report, evidence trails, scorecards, and generated deliverables.
How long it takes
Most projects finish within a few minutes of upload. Larger document sets (50+ files or long transcripts) can take longer. You can leave the page — we'll keep processing in the background.
02
Uploading project information
Where to upload
After signing in and paying for a project, you'll land on the Upload screen. You can also reach it from Account → your project → Add documents.
How to upload
- Drag files onto the upload area, or click to choose from your device.
- Upload everything that describes the project — context is what produces insight.
- You can add more documents later; the analysis will re-run incorporating the new files.
Accepted formats
- Documents
- PDF, DOCX, DOC, TXT, MD, RTF
- Spreadsheets
- XLSX, XLS, CSV
- Presentations
- PPTX, PPT
- Transcripts & notes
- TXT, MD, VTT, SRT
- Email exports
- EML, MSG, or pasted into a TXT file
- Images of documents
- PNG, JPG (OCR is applied)
Limits
- Max file size: 20 MB per file.
- Recommended: under 100 files per project for fastest turnaround.
- Only the first 50 pages of very long PDFs are deeply parsed; the rest is summarized.
- Files must contain extractable text or recognizable images. Scanned PDFs work; password-protected PDFs do not.
What makes a good upload set
- Anything that states objectives, scope, constraints, or stakeholder needs.
- Decision records, meeting minutes, and email threads — these often hold the real requirements.
- Existing requirement docs, user stories, acceptance criteria.
- Architecture notes, integration lists, compliance constraints.
03
What you'll see while it runs
Once you finish uploading, the project moves to the Processing screen. You'll see four stages, each with a live status indicator:
- 01
Ingestion
Files are parsed and chunked.
- 02
Entity extraction
Objectives, stakeholders, requirements, risks, constraints, and decisions are pulled out and linked.
- 03
Gap detection
Missing, conflicting, or unsupported items are flagged.
- 04
Scoring
A readiness score and stage detection are computed.
Visuals you'll see
The Project Knowledge Model visualizes the entities and the relationships between them. The Readiness Timeline shows where the project sits across discovery, elicitation, analysis, solution design, and delivery readiness. Color coding: navy = stable, orange = attention required, red = blocker.
04
Reading your report
Where to find it
When analysis completes, you'll be notified by email and routed to the report. You can also reopen it any time from Account.
What each section means
- Stage & readiness
- Where the project sits today and a 0–100 score for how ready it is to move forward.
- Report Scorecards
- Per-knowledge-area scores (objectives, stakeholders, requirements, risks, traceability) mapped to BABOK so you can see where the project is strong vs. thin.
- Objectives
- What the project is trying to achieve, and whether each one is measurable and traceable.
- Stakeholders
- Who is involved, who has authority, and who is missing.
- Requirements
- What needs to be true, grouped by type, with quality flags.
- Risks & constraints
- Surfaced risks, dependencies, and limits — including ones never explicitly stated.
- Gap findings
- Specific issues to fix, ranked by impact, each backed by source evidence.
- Repair plan
- Concrete next actions tied to BABOK, SAFe, or Lean Six Sigma practice.
Evidence on every finding
Click any finding to open the Evidence Trail. It shows the exact passages and documents the finding was derived from, so nothing is unverifiable.
05
Coaching, techniques & scorecards
Beyond the core report, RequirementsHub gives you working surfaces to improve a project — not just read about it. These features are available on Requirements Intelligence Report+, Pro, and Consultant.
Project Coaching Workspace
A guided workspace that turns gap findings into concrete activities. Each coaching activity is grounded in BABOK, SAFe, or Lean Six Sigma and tells you what to do next, who to involve, and what artifact to produce. Activities are scoped to your project's current stage and update as you add more documents.
BA Techniques
A library of applied Business Analysis techniques — SIPOC, CTQ trees, stakeholder maps, RACI, BDD acceptance criteria, story slicing, traceability matrices, and more. Run a technique against your project to generate a deliverable that's pre-filled with your real entities, evidence, and gaps instead of a blank template.
Report Scorecards
Scorecards break the readiness score into per-discipline grades so you can see why the project scored what it did. Each scorecard links back to the findings and source evidence that drove it, and is recomputed every time you re-analyze.
Where to find them
Open any report from /account. Scorecards sit at the top of the report. Coaching and Techniques open from the report side panel when your plan includes them.
06
Outputs, downloads & sharing
- Full report PDF — one click from the report header.
- Evidence trail export — per-finding source passages and citations.
- Scorecards export — per-discipline grades with linked findings.
- Repair plan export — prioritized actions you can drop into your tracker.
- Generated deliverables — outputs from BA Techniques and Coaching activities.
- Raw data export (ZIP) — all extracted entities, scores, and findings in JSON.
How to interpret outputs
- Start with the readiness score and the top three gap findings.
- Move to the repair plan — each action is sized and ordered.
- Use evidence trails when reviewing with stakeholders so claims are sourced.
Access tip
Every export button lives on the report page or in the Data Control Center at /account/data. If a button is greyed out, your current plan does not include that output — upgrade on the Pricing page.
Sharing
Reports are tied to your account. To share with a teammate, export the PDF or invite them to your project. Public sharing links are not enabled by default for privacy reasons.
07
Errors & troubleshooting
- Upload failed: file too large
- Split the file or compress it under 20 MB.
- Unsupported format
- Re-export to PDF, DOCX, or TXT and re-upload.
- No text extracted
- Likely a scanned or image-only PDF with poor quality. Re-scan at 300 DPI or paste text into a TXT file.
- Password-protected PDF
- Remove the password and re-upload.
- Processing stuck
- Refresh the project page. If still stuck after 30 minutes, email support.
- Report looks thin
- The model only knows what you uploaded. Add meeting notes, emails, or decision records and re-run.
- 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 project name and the screen you were on.
08
Plans & pricing tiers
Managing your account
- Sign in and account home: /account.
- Sign-in is magic-link by email — no password.
- To change the email on your account, contact support and we'll migrate your projects.
One-time vs. subscription
One-time tiers analyze a single project and never recur. Subscriptions cover unlimited projects and unlock ongoing re-analysis, coaching, techniques, and deliverables across your whole portfolio.
The four tiers
- Requirements Intelligence Report — $19 one-time
- One-time diagnostic for a single project. Full report with stage, readiness score, Report Scorecards, gap findings, evidence trails, and a repair plan. No coaching, no generated deliverables.
- Requirements Intelligence Report+ — $49 one-time
- Everything in the Report, plus the Project Coaching Workspace and BA Techniques for that one project — turn the gaps into concrete deliverables (SIPOC, CTQ, stakeholder map, BDD acceptance criteria, traceability matrix, and more).
- RequirementsHub Pro — $29/month
- Unlimited projects. Re-analyze any time, full Project Coaching Workspace and BA Techniques across every project, Project Intelligence Timeline, and Knowledge Model version history.
- RequirementsHub Consultant — $79/month
- Everything in Pro, plus multi-client workspaces, consultant-grade exports, and branded report covers for client delivery.
How to choose
- One project, just want the diagnostic → Requirements Intelligence Report.
- One project, want the diagnostic and the deliverables to fix it → Report+.
- Multiple projects, ongoing work → Pro.
- Multiple clients, white-label exports → Consultant.
Re-runs on a project you already own are always included — add documents and re-analyze at no extra cost. See current pricing on the Pricing page.
Receipts & billing
Payment is processed via Stripe. A receipt is emailed automatically. For invoices or VAT details, contact hello@requirementshub.ai.
09
Managing your data
You own everything you upload
- Your documents and reports are stored privately and tied to your account.
- We do not train models on your content.
- Every action below is self-service — no tickets, no waiting.
Walkthrough: view your project data
- 01
Open your account
Go to /account. You'll see every project tied to your email, with its current stage (uploading, processing, ready) and status.
- 02
Open a project
Click a project to see its uploaded documents, extracted entities, gap findings, and the full report once analysis has finished.
- 03
Inspect evidence
Inside the report, every finding links back to the exact document, page, and quote it was derived from — use this to verify before acting.
- 04
Download outputs
Use the export buttons on the report page for PDF, or open the Data Control Center for a complete raw ZIP (projects, entities, findings, scores, generated outputs) as JSON.
Walkthrough: export everything
- 01
Open the Data Control Center
Go to /account/data. The first card is Export Everything.
- 02
Click ‘Export Everything’
We package every project you own — metadata, entities, relationships, gap findings, scores, and generated outputs — into a single ZIP.
- 03
Save the ZIP
Your browser downloads requirementshub-export-YYYY-MM-DD.zip. Open it to find one folder per project, each containing plain JSON files you can read, archive, or import elsewhere.
Tip
The export is generated on demand and reflects the state of your data at the moment you click. Re-run it any time you want a fresh snapshot.
Walkthrough: delete a single project
- 01
Open the Data Control Center
Go to /account/data and scroll to Delete a Project. You'll see every project tied to your account.
- 02
Click ‘Delete’ on the project
A confirmation dialog opens showing the exact project name.
- 03
Type the project name to confirm
Type the project name exactly as shown. The Delete Permanently button only activates on an exact match — this is the guardrail that prevents accidental deletes.
- 04
Confirm
We remove the project record, every uploaded document in storage, all extracted entities and relationships, gap findings, scores, and any generated outputs. This cannot be undone.
Walkthrough: delete your account
- 01
Export first (recommended)
If you might want your data later, run Export Everything before continuing. After deletion, there is nothing to restore.
- 02
Open Delete My Account
On /account/data, scroll to the red Delete My Account card and click the button.
- 03
Type DELETE to confirm
Type
DELETE(uppercase) in the confirmation box. The final button only activates on an exact match. - 04
What gets removed
Every project, uploaded document, extracted entity, gap finding, score, generated report, and your account profile. Any active subscription is cancelled. Irreversible.
Tip
Need to keep the data but stop using the account? Export Everything, then delete projects individually — you can leave the account dormant without removing it.
Quick reference
- View projects
- /account
- View a report & evidence
- Open a project from /account
- Download a report (PDF)
- Report page → Export
- Export all raw data (ZIP)
- /account/data → Export Everything
- Delete a single project
- /account/data → Delete a Project
- Delete account & all data
- /account/data → Delete My Account
Privacy & security
Review the Privacy Policy, Security page, and Data Handling policy for the full details.
Still stuck?
Email hello@requirementshub.ai with your project name and a short description. We typically reply within one business day.