Author: [name of the author]
Date: [date]
This document is stored in an electronic form using Git source control management software.
This section provides an introduction to the project or the feature. All SRS documents must be uniquely identified by a number. In this case this document is identified by the number
CH-SRS001
The document number must always be used as a prefix to the document title. For example,
CH-SRSxxx Name of the document
All the requirements must be specified in the Requirements section.
Note that currently the table of contents is generated manually using
cat CH_SRS001_ClickHouse.md | tfs document toc
command and needs to be updated any time requirement name is changed or a new requirement is added.
You can easily generate a pretty HTML version of this document using the command.
cat CH_SRS001_ClickHouse.md | tfs document convert > CH_SRS001_ClickHouse.html
You can convert this SRS into the requirements.py by using the command.
cat CH_SRS001_ClickHouse.md | tfs requirements generate > requirements.py
You can define terminolgy using the examples below and you can make them linkable as SRS by defining the links in the References section.
Software Requirements Specification
Some description of the term that you would like to use.
This section includes all the requirements. This section can be structured in any way one sees fit.
Each requirement is defined by the section that starts with the following prefix:
RQ.[document id].[requirement name]
then immediately followed by a one-line block that contains the
the version of the requirement.
version: 1.0
This is a long description of the requirement that can include any relevant information.
The one-line block that follows the requirement defines the version
of the requirement. The version is controlled manually and is used
to indicate material changes to the requirement that would
require tests that cover this requirement to be updated.
It is a good practice to use requirement names that are broken up into groups. It is not recommended to use only numbers because if the requirement must be moved the numbering will not match. Therefore, the requirement name should start with the group name which is then followed by a number if any. For example,
RQ.SRS001.Group.Subgroup.1
To keep names short, try to use abbreviations for the requirement's group name.
version: 1.0
This an example of a sub-requirement of the RQ.CH-SRS001.Example.
version: 1.0
ClickHouse SHALL return 1 when user executes query
SELECT 1