User guide
How to use Requel 2.0, a web application for writing requirements with everyone who has a stake in them. To install and run it, see Installing and running Requel.
How Requel thinks about requirements
Everything lives in a project. A project holds the requirements, the people who work on them, and the discussion about them.
- Goals
- What the system must achieve, and why. Goals can support, refine, conflict with or depend on each other.
- Stories
- A short narrative of one person using the system, either succeeding or hitting a problem.
- Actors
- The roles that use the system: people, other systems or devices.
- Use cases and scenarios
- A use case says what an actor does with the system. Its scenarios are the steps, as a main flow plus alternatives and exceptions.
- Glossary
- The project's terms and what they mean, with alternate names pointing at the preferred one.
- Stakeholders
- The people and groups with a say in the requirements. Users who are stakeholders get permissions on the project.
- Annotations
- Notes and issues attached to any of the above. An issue collects positions (possible resolutions) and arguments for and against them until someone resolves it.
- Assistants
- Automated checks that read the text and raise issues: vague words, spelling, complex sentences and likely glossary terms, plus the optional AI review.
Contents
Getting started
Log in, find your way around, change your password, add users.
Projects
Create, import, export and delete projects; the project overview.
Requirements
Goals, stories, actors, use cases, scenarios, the glossary and tags.
Stakeholders
Who is on a project and what each person may change.
Issues and discussion
Notes, issues, positions and arguments; the built-in checks; open issues.
AI review
Reviews, policies and corpus analysis by an AI model you choose.
Reports
Turn a project into a specification or a ticket with an XSLT template.
API, MCP and CLI
Tokens, the REST API, AI clients over MCP, and
requel-cli.
Try it with the sample project
The screenshots in this guide show the sample project, the requirements for Requel itself. Download Requel.xml and import it (Projects → Import) to follow along.