Skip to content

Commit 4add437

Browse files
docs: add Tag Filtering feature to guide and reference ContinuousCompliance strategy (#121)
* Initial plan * docs: add Tag Filtering feature and ContinuousCompliance reference Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> * docs: align ContinuousCompliance reference with TemplateDotNetTool pattern Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
1 parent 04b72b9 commit 4add437

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ create, validate, and manage requirement documents in a structured and maintaina
2727
-**Validation** - Built-in validation for requirement structure and references
2828
- 🏷️ **Tag Filtering** - Categorize and filter requirements using tags
2929
- 📋 **Justifications** - Document the rationale behind each requirement
30+
- 🔒 **Continuous Compliance** - Compliance evidence generated automatically on every CI run, following
31+
the [Continuous Compliance][link-continuous-compliance] methodology
3032

3133
## Installation
3234

@@ -569,3 +571,4 @@ For information about reporting security vulnerabilities, please see our [Securi
569571
[github-actions]: https://github.com/features/actions
570572
[sonarcloud]: https://sonarcloud.io
571573
[link-guide]: https://github.com/demaconsulting/ReqStream/blob/main/docs/guide/guide.md
574+
[link-continuous-compliance]: https://github.com/demaconsulting/ContinuousCompliance

docs/guide/guide.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ to be treated as code, stored in source control, and integrated into CI/CD pipel
3737
- **Justifications** - Document the rationale behind each requirement for better understanding
3838
- **File Includes** - Modularize requirements across multiple YAML files for better maintainability
3939
- **Validation** - Built-in validation ensures requirement structure and references are correct
40+
- **Tag Filtering** - Categorize and filter requirements using tags for focused reporting and enforcement
4041
- **Export Capabilities** - Generate markdown reports for requirements, justifications, and test trace matrices
4142

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

53+
# Continuous Compliance
54+
55+
ReqStream is a key component of the [Continuous Compliance][continuous-compliance] methodology by DEMA Consulting,
56+
which ensures compliance evidence is generated automatically on every CI run.
57+
58+
## Key Practices
59+
60+
- **Requirements Traceability**: Every requirement is linked to passing tests, and a trace matrix is
61+
auto-generated on each CI run
62+
- **Tag-Based Filtering**: Requirements can be tagged to generate focused compliance reports for specific
63+
categories (e.g., security, regulatory)
64+
- **Enforcement Mode**: CI/CD pipelines fail if requirements lack passing tests, ensuring coverage is
65+
maintained on every commit
66+
- **Automated Audit Documentation**: Each release ships with generated requirements, justifications, and
67+
trace matrix documents
68+
5269
# Prerequisites
5370

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

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

1397+
<!-- Link References -->
13801398
[dotnet-sdk]: https://dotnet.microsoft.com/download
13811399
[repo]: https://github.com/demaconsulting/ReqStream
13821400
[issues]: https://github.com/demaconsulting/ReqStream/issues
13831401
[discussions]: https://github.com/demaconsulting/ReqStream/discussions
1402+
[continuous-compliance]: https://github.com/demaconsulting/ContinuousCompliance

0 commit comments

Comments
 (0)