Requirements Manager

This tool helps to manage requirements written in Markdown.

Install

Reqman is a binary file that must be stored in a directory. The files can be found here.

For Linux, the execution bit must still be set.

chmod u+x reqman

Or here in a command:

wget -O ~/.local/bin/reqman http://download.schukai.com/tools/reqman/reqman-$( uname -s | tr [:upper:] [:lower:])-$(echo `uname -m | sed s/aarch64/arm64/ | sed s/x86_64/amd64/`) && chmod u+x ~/.local/bin/reqman

Commands

General Parameters

The date format for the output can be specified with the parameter --date-format.

All confirguration values can also be specified in a configuration file. The configuration file can be specified with the --config parameter.

If no path is specified, the configuration file config.yaml is first searched for in the working directory. If this is not found, the file is searched for in the home directory ~/.config/requirements-manager/config.yaml.

Finally, we look for the configuration in the /etc/requirements-manager/config.yaml directory.

The parameter path specifies the path.

Help

There is help on the command line for each individual command.

reqman --help

New Requirements

A new request can be created with the following command.

reqman requirements add --id 1425

An entirely new file with a structure is created. The --id 1425 is both the file name and the ID of the request.

All available fields are listed in the new file.

Output a PDF

A PDF can be created using the following command:

reqman overview \
       print \
       --path=requirement/documents   \
       --column=ID \
       --column=Title  \
       --template=template/schukai.md  \
       --latex-template-path=requirement/template/schukai.latex \
       --output=report.pdf \
       --format=pdf

In this case, the markdown files in the path requirement/documents are read.

A table with all requirements is created in the file and the two columns ID and Title are used. Additional columns can be added using additional options --column.

File template/schukai.md is used as a template.

The LaTeX template requirement/template/schukai.latex is used for the design of the PDF.

The output format is PDF and the filename of the PDF document is report.pdf.

You can use a complete directory or a subdirectory as the path.

Output of the tasks

Tasks are used to document open points in the document itself.

For example, if a description is still missing or a picture needs to be added.

A task can be defined by the notation - [ ] task or - [] 2022-12-13 task with due date.

Completed tasks should at best be deleted from the document. However, they can also be set as completed by writing [x] 2022-12-13 done task.

example:

- [ ] task 1
- [ ] tast 2
- [x] 2022-12-13 task 3 with due date

The call is as follows:

reqman tasks print --path=examples/

The output is then of the type:

Output of the items

reqman requirements print --path examples/ --column ID --column Title

The output is then of the type:

More columns can be added with --column.

Output of privacy

reqman privacy print --path=example/

Output of requirements

reqman requirements print --path=example/ --column=ID --column=

The output is then of the type:

Output changelog

reqman changelog print --path=example/

The output is then of the type:

### 01.05.2022

- Requirement (R2)

### 24.01.2022

- Requirement (R1)

Output report

requirements report --grouped-by ID

This command produces two tables:

1. Groups all estimates and adds up the estimate and the booked times. This allows you to see how much time you have spent.

2. This table shows for each plan value the hours needed, the mean, the variance and the standard deviation.

On average, we needed 3 hours in the example. However, we needed 6 hours for 2 requirements.

The variance, or standard deviation, gives us a measure of how accurate we are. The smaller the standard deviation, the better.

So, what decision can we derive? If a new requirement is estimated at 40, the hours offered should be between 3 and 5.

Sync with GitLab

You can synchronize the issues of a document with a GitLab server.

reqman gitlab sync --path=example/

If no ID is defined in the document, an issue is created,

issues:
  - gitlab:
      title: "Issue 1"

otherwise, the data is updated.

issues:
  - gitlab:
      id: 1

Structure

The Text

The individual requirements are Markdown files with integrated YAML structure. The YAML structure must be introduced with --- and closed with ....

The data from the YAML block can be integrated in the text via placeholders.

For example, the following statement can be used to include the items within the document.

{{ if.Items }}
**Items**

| ID                 | Name         |        Delivery until |                              Provided on |
|--------------------|--------------|----------------------:|-----------------------------------------:|
{{ range.Items
}}| {{ .ID }} | {{ .Name }} | {{ .DeliveryUntil.Format "02.Jan" }} | {{ .ProvidedOn.Format "02.Jan"  }} |
{{ end }}

{{ end }}

If the PDF function is used, LaTeX commands can also be included in the text. For example, the LaTeX instruction ` /newline' leads to a line break.

YAML

│ -> |

Date

If a date is expected as a parameter, it must be entered in a special format depending on the type. The following table provides information about the individual formats. The format can be looked up in the first column of the table below.

Latex

Individual LaTeX commands can be looked up here:

• tug.ctan.org/info/latex-refsheet/LaTeX_RefSheet.pdf
• www.uni-frankfurt.de/53485609/latexsheet.pdf
• www.latex4ei.de/downloads/LaTeX_CheatSheet.pdf
• download.schukai.com/tools/reqman/

Change Log

• Version 1.0
  • Bug fixes
  • Added support for gitlab sync command
  • initial release