RM2Doc

Introduction

RM2Doc is a tool for automatic generation of a requirements document from a requirements model. The benefits of RM2Doc are as follows:

  1. Automatic generation of ISO/IEC/IEEE 29148-2018 conformed requirements documents from UML models without any templates.
  2. Automatic generation of the flow description from a use case without additional information.
  3. Automatic generation the semantic description of system operations only based on the formal expression of OCL.

The video cast its feature is listed as follows (Youtube):

RM2Doc Installation

Prerequest

RM2Doc is an advanced feature of RM2PT. We recommend you to use RM2Doc in RM2PT. If you don’t have RM2PT, download here.

Online Installation

Open RM2PT, click on Help -> Install New Software

image-20220507173100117

Type http://rm2pt.com/RM2Doc-UpdateSite in the Work with field, select RM2Doc and click Next.

image-20220507173453144

Offline Installation

If the update site does not work, you can choose to install it offline. Click here to download RM2Doc. Follow the steps below to install.

image-20211017150545091

image-20211017150807041

image-20211017150921155

image-20211017150951456

RM2Doc Tutorial

Prerequest

In order to generate the documentation, you need a requirements model, the RM2PT project. For creating or importing a RM2PT project,you can see the tutorial here.

Input of RM2Doc — Requirements Model

rm

The input to RM2Doc is a UML requirements model with OCL constraints. The model includes: , a use case diagram, system sequence diagrams, contracts of and system operations.

Generate NL Contract

After you add a requirements model, you can generate NL contracts for OCL contracts by right click on cocome.remodel -> RM2PT-> ` Advance Features-> Generate NL Contract`

image-20220507174915467

Refresh your remodel file to see the generated NL contracts.

Generate SRS

You can generate a document by right click on cocome.remodel -> RM2PT-> ` Advance Features-> Generate ISO/IEC/IEEE 29148-2018 SRS`

image-20220507175314891

The generated document is in the doc-gen folder

image-20220507175508334

The Output of RM2Doc

RM2PT can generate five parts of a document:

In the rest of the requirements document, we have predefined guidelines for writing in accordance with the ISO/IEC/IEEE 29148-2018.

The image below shows a part of CoCoME’s requirements document. For more details, please see https://github.com/RM2PT/CaseStudies. doc