Requel

User guide for Requel 2.0

Projects

A project holds one system's requirements, its stakeholders and their discussion.

The project list

Projects → List in the sidebar shows every project you can open, with its organization, status, creator and how many stakeholders, goals, stories and use cases it has. Search narrows it; the column headings sort it; the row menu has the project’s actions.

The project list with one project, Requel.

Create a project

Choose New (sidebar) or New Project (list). Give it a name, and optionally an organization and description, then Continue to add tags or finish. You need the createProjects permission (users).

The New Project wizard: Details (name, organization, description) and an optional Tags step.

You become the project’s first stakeholder, with every permission. The project starts with two report templates, an HTML specification and a Markdown ticket (Reports).

The project overview

Click a project’s name to open its overview.

The Requel project overview: count tiles, open issues, next actions, assistants and corpus analysis.

Edit a project

Edit project on the overview changes the name, organization, description and tags. Its Export button is how you save a copy.

The project edit page with Details and Tags tabs and an Export button.

Import and export

Export (on the project’s edit page) downloads the whole project as XML: requirements, stakeholders and their permissions, glossary, dictionary, tags, reports and every note and issue. The file follows the published project schema.

An export includes the user accounts its stakeholders and authors belong to, password hashes included. Treat the file like the database it came from.

Import (sidebar or list) reads such a file into a new project:

Export and import are also how you copy a project to another Requel server, and how you move projects from Requel 1.0 or 1.1 (Upgrading).

Delete a project

Delete project on the overview removes the project and everything in it. The dialog offers Download backup (the XML export) first; then Delete permanently. It can’t be undone, other than by importing the backup.