Skip to content

Latest commit

 

History

History
92 lines (65 loc) · 2.04 KB

requirements-block.adoc

File metadata and controls

92 lines (65 loc) · 2.04 KB
Raw

Requirements Block

Usage
.title
[req,id=RSL-3,version=1]
--
Contents of the requirement
--
Attributes

  • title (required): An anchor is derived from the requirement title and embedded at the beginning of the rendered output.

  • ID: (required) The ID in the form <Prefix>-<Number>, used to generate an anchor

  • version: (required) value is a non-negative integer.

Note
 Omitting any of the above attributes will print an error to the console and insert a warning text in the generated document. * delimiter: Lines containing only two hyphens -- delimit the block. This is required if the block contains empty lines or nested formatting.

ID Pattern

The purpose of the <Prefix>-<Number> ID is to ensure that Requirements are both unique and easily referenceable. Currently, the ID may be any string, but should conform to the following conventions:

<Prefix>:

R (requirement) followed by the project prefix (i.e. SL for stdlib)

<Number>:

The requirement number, currently not validated. A validation stage for requirement IDs (detecting duplicates, for instance) is planned.

Example

The following example demonstrates how to document Requirement #3 for stdlib Version 1;

.This is the title
[req,id=RSL-3,version=1]
--
My Super Requirement
--

Req. RSL-3: This is the title (ver. 1)
My Super Requirement

Xrefs

Cross-referencing requirements is done using the syntax <<Req-ID,Optional Link Text>>, e.g. for the following requirement:

[req,id=ROPR-14603,version=1]
--
...
--

can be cross-referenced using the following syntax

See <<Req-ROPR-14603>>, or see also <<Req-ROPR-14603,confirm the booking>>.