Writing Requirements

Sphinx-Needs enables your team to create, manage and analyze requirements, specifications, test cases, and more inside Sphinx-based documentation.

See the official documentation for more details: Sphinx-Needs

A need item is a generic object which can become anything you you require for your project: a requirement, a test case, a user story, a bug, an employee, a product…

A basic need item looks like this:

Requirement: Basic need example REQ_42

links incoming: REQ_43

A basic example of a need item.

See also

The official Sphinx-Needs tutorial is a great starting point to learn more about Sphinx-Needs.

Lets create a second requirement that links to the first one:

Requirement: Requirement linking to another requirement REQ_43

status: open links outgoing: REQ_42

This is a requirement that links to another requirement via its id and has a status.