Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ create, validate, and manage requirement documents in a structured and maintaina
- ✅ **Validation** - Built-in validation for requirement structure and references
- 🏷️ **Tag Filtering** - Categorize and filter requirements using tags
- 📋 **Justifications** - Document the rationale behind each requirement
- 🔒 **Continuous Compliance** - Compliance evidence generated automatically on every CI run, following
the [Continuous Compliance][link-continuous-compliance] methodology

## Installation

Expand Down Expand Up @@ -569,3 +571,4 @@ For information about reporting security vulnerabilities, please see our [Securi
[github-actions]: https://github.com/features/actions
[sonarcloud]: https://sonarcloud.io
[link-guide]: https://github.com/demaconsulting/ReqStream/blob/main/docs/guide/guide.md
[link-continuous-compliance]: https://github.com/demaconsulting/ContinuousCompliance
19 changes: 19 additions & 0 deletions docs/guide/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ to be treated as code, stored in source control, and integrated into CI/CD pipel
- **Justifications** - Document the rationale behind each requirement for better understanding
- **File Includes** - Modularize requirements across multiple YAML files for better maintainability
- **Validation** - Built-in validation ensures requirement structure and references are correct
- **Tag Filtering** - Categorize and filter requirements using tags for focused reporting and enforcement
- **Export Capabilities** - Generate markdown reports for requirements, justifications, and test trace matrices

## Use Cases
Expand All @@ -49,6 +50,22 @@ ReqStream is ideal for:
- Organizations requiring compliance documentation
- Agile teams wanting lightweight, maintainable requirements management

# Continuous Compliance

ReqStream is a key component of the [Continuous Compliance][continuous-compliance] methodology by DEMA Consulting,
which ensures compliance evidence is generated automatically on every CI run.

## Key Practices

- **Requirements Traceability**: Every requirement is linked to passing tests, and a trace matrix is
auto-generated on each CI run
- **Tag-Based Filtering**: Requirements can be tagged to generate focused compliance reports for specific
categories (e.g., security, regulatory)
- **Enforcement Mode**: CI/CD pipelines fail if requirements lack passing tests, ensuring coverage is
maintained on every commit
- **Automated Audit Documentation**: Each release ships with generated requirements, justifications, and
trace matrix documents

# Prerequisites

To use ReqStream, you need:
Expand Down Expand Up @@ -1377,7 +1394,9 @@ For more information, visit the [ReqStream GitHub repository][repo].

For support, please [open an issue][issues] or [start a discussion][discussions].

<!-- Link References -->
[dotnet-sdk]: https://dotnet.microsoft.com/download
[repo]: https://github.com/demaconsulting/ReqStream
[issues]: https://github.com/demaconsulting/ReqStream/issues
[discussions]: https://github.com/demaconsulting/ReqStream/discussions
[continuous-compliance]: https://github.com/demaconsulting/ContinuousCompliance
Loading