sltoo 25.0.5

Unique Feature Set

rmtoo fits perfectly in a development environment using text editors and command line tools such as emacs, vi, eclipse, make, maven.

• Use simple text files as input - use your favorite editor

• Many different output formats and artifacts are supported:

  • PDF - with links to dependent requirements

  • HTML - also with links to dependent requirements

  • Requirements dependency graph

  • Requirement count history graph

  • Lists of unfinished requirements including priority and effort estimation, e.g., for use in agile project development

• Fully integrated revision control system: git. Usages: history, statistics and baseline handling.

• A topic based output handling provides a common set of files for different types of output (PDF, HTML, …)

• Complete support for automatic checking of constraints.

• Analytics modules: Heuristics help to evaluate the quality of requirements

• Modules to support commercial biddings based on a given set of requirements

• Emacs mode files for editing requirements and topics included

• Experimental output in XML

• Fully integrated with Makefile handling of all artifacts

• Fully modular design: additional output requires minimal effort

• During parsing most common problems are detected: all syntax errors and also many semantic errors.

• Fully automated test environment - tests about 95% of the code and is shipped with rmtoo packages to check for possible problems in different environments.

Dependencies

To use sltoo, other software packages must be installed.

sltoo is written in python. At least version 3.6 and 3.8 are supported, but other versions should work just fine.

When you want to create LaTeX or PDF documentation, LaTeX is needed.

For the requirements dependency graph, graphviz is used.

For statistics plot gnuplot is used. For the estimation module the python-scipy package is needed.

Typically the packages from your distribution will work. For Ubuntu the following packages are needed:

sudo apt-get install texlive-font-utils texlive-latex-base \
texlive-font-utils graphviz gnuplot
sudo apt-get -y install texlive-latex-recommended \
texlive-pictures texlive-latex-extra
pip3 install unflatten

For Fedora these packets:

sudo dnf install gnuplot texlive-latex texlive-tocloft \
texlive-fancyhdr texlive-epstodpf texlive-metafont texlive-mfware

virtualenv / pip

This is the preferred installation method — it takes care of installing the python dependencies correctly.

To install sltoo in a virtualenv, execute the following steps:

python3 -m virtualenv venv
source venv/bin/activate
pip install sltoo

This has to be done once.

Setup

Change to a directory where you want to create the new project. We assume the virtualenv is available is the same directory (this is not necessary).

git clone git@github.com:kown7/rmtoo.git
cp -r rmtoo/contrib/template_project MyNewProject

Usage

To create all the artifacts for the template project, execute

cd MyNewProject
make
ls artifacts

All the generated files are in the artifacts directory.

A typical workflow is to change or add requirements, topics or the configuration in the MyNewProject directory, run make again and check the artifacts.

The generated Excel file artifacts/specification.xlsx can be used to change the Topics and Requirements. If the changes are to be incorporated into the document simply put the Excel-file into the imports folder and run make clean && make. Do not forget to git add and commit any changes made! To avoid problems with lock-files, copy the artifacts/specification.xlsx somwhere else to edit.