Automatic creation of requirements based on excel table
The use cases and scenarios are listed in an Excel table. This list is extracted and a document page is created for each entry with the metadata entered in the table.
A detailed description for the application can be added.
Installation
Download the source code and the generate file for the appropriate operating system from the releases.
Reading data from the excel table
-
For each Page: save the pages to be exported as a .csv file with ";" as a delimiter.
-
Copy the file to the root directory, with the name of the request. e.g.: use-cases.csv
-
run generate with the command for the requirement. e.g.:
./generate use-cases
In the appropriate folder ( e.g.: use-cases-gernerated) the jekyll files are created with Front Matter with the metadata
Add description of the requirements
description must be written in the documentation repository. When a new requirement is generated, a template file is created for it in the _include folder. The template looks like this:
<!-- A general description of the requirement can be given here. -->
Lorem ipsum dolor sit amet consectetur adipisicing elit. Perferendis voluptas deserunt alias accusantium rem? Quaerat, temporibus alias fuga rerum unde dolor blanditiis quia incidunt modi rem, sequi, esse aut accusamus.
<!-- This include inserts the table with the metadata -->
{% include properties_list.html %}
<!-- here is the description in detail -->
Lorem ipsum dolor sit amet consectetur adipisicing elit. Unde nihil sequi ipsam blanditiis optio nulla quidem tempore sapiente nam, molestiae et voluptas ab harum quo incidunt reiciendis dolorum sed eligendi quos in itaque vel facilis. Rerum quia asperiores porro, odit laborum error voluptates repellat repellendus doloribus minima voluptate debitis libero nemo sit, dolorem consequatur expedita architecto! Molestiae, quae maxime ut iste ratione veniam velit asperiores. Earum corrupti architecto molestiae necessitatibus ullam modi beatae optio distinctio et labore, consectetur, repudiandae alias recusandae quas delectus placeat error laudantium quos, autem non nemo cum. Obcaecati iure maiores quas temporibus assumenda, qui veritatis necessitatibus.
<!-- detailed information about integration and development can be found in this chapter -->
# Developer Corner
<!-- How to import a graphic stored in the include folder -->
<details >
<summary>Flowchart</summary>
<div>{% include diagrams/Enmeshed_Scenarios.svg %}</div>
</details>- Copy the new generated template to the _include folder in the documentation repository
Use the default template
In the folder for the requirement is a default.md file. This can be used if there is no description for the respective requirement. In the Excel table, the value default must now be entered in the published column.
! Adding a specific description overwrites the "default" flag