Repository navigation
#613: Added terminating specification item example to user guide. #627
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
redcatbear
merged 2 commits into
main
from
documentation/613_terminating-specification-item
Oct 9, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 changes: 56 additions & 0 deletions
56
doc/user_guide/use_cases/partial_tracing_by_responsibility.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| layout: default | ||
| title: Partial Tracing by Responsibility | ||
| parent: Use Cases | ||
| grand_parent: User Guide | ||
| nav_order: 4 | ||
| --- | ||
|
|
||
| ### Partial Tracing by Responsibility | ||
|
|
||
| In a software project, different roles are responsible for different layers of the traceability chain. Product owners work with features (`feat`) and requirements (`req`), architects with architecture and detailed design (`arch`, `dsn`), developers with implementation and unit tests (`impl`, `utest`), and test engineers with integration and system tests (`itest`, `stest`). | ||
|
|
||
| When Soeren, the product owner, adds a feature and its system requirements, a full trace could report missing design or implementation that is not part of his review. Andrea, the architect, can likewise check design coverage before development is complete. The artifact type filter lets each role trace the layers relevant to their work. | ||
|
|
||
| For example, the layers may be organized like this: | ||
|
|
||
| ```text | ||
| [Product owner] feat ──> req | ||
| [Architect] └──> arch ──> dsn | ||
| [Developer] └──> impl, utest | ||
| [Test engineers] └──> itest, stest | ||
| ``` | ||
|
|
||
| Each level declares the artifact types needed to cover its specification items (`Needs: ...`). | ||
|
|
||
| Use the `-a` or `--wanted-artifact-types` option with a comma-separated list of [artifact types](../../terminology.md#artifact-type) to limit a trace. Items, coverage needs, and links for types outside the list are left out of the trace; the filter narrows the trace results, not the files parsed. | ||
|
|
||
| Soeren, the product owner, checks that each user feature (`feat`) is specified by system requirements (`req`): | ||
|
|
||
| oft trace -a feat,req doc/ | ||
|
|
||
| This checks feature-to-requirement coverage without reporting missing downstream design or implementation. | ||
|
|
||
| After the requirements are in place, Andrea, the architect, checks their coverage by architecture and detailed design: | ||
|
|
||
| oft trace -a feat,req,arch,dsn doc/ | ||
|
|
||
| Including both feature and requirement items keeps the earlier layer in the trace; the filter does not require implementation or tests yet. | ||
|
|
||
| Wan and Wu, the developers, check implementation and unit tests along with the preceding specifications: | ||
|
|
||
| oft trace -a feat,req,arch,dsn,impl,utest doc/ src/ | ||
|
|
||
| When integration and system tests are ready, test engineers include their types in the filter: | ||
|
|
||
| oft trace -a feat,req,arch,dsn,impl,utest,itest,stest doc/ src/ | ||
|
|
||
| #### Artificial Termination of Specification Items | ||
|
|
||
| In a full trace, a chain ends at [terminating specification items](../../terminology.md#terminating-specification-item)—items that do not require further coverage (such as source code or test markers without a `Needs:` declaration). | ||
|
|
||
| When you trace with an artifact type filter, OFT strips all coverage requirements for artifact types that are not in the filter list. For instance, when Soeren runs `oft trace -a feat,req doc/`, a system requirement that normally declares `Needs: arch` has its `arch` requirement removed during the trace. This *artificially terminates* the requirement items at the boundary of the selected artifact types, allowing the trace to pass without missing-coverage errors for downstream artifacts that have not yet been written. | ||
|
|
||
| See also: | ||
| * [Distributing the Detailing Work](distributing_the_detailing_work.md) for filtering by tags across multiple teams | ||
| * [Import Options](../reference/oft_command_line.md#import-options) for command-line syntax details | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 1 addition & 2 deletions
3
doc/user_guide/use_cases/tracing_the_whole_chain_in_the_same_file_system.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 1 addition & 2 deletions
3
doc/user_guide/use_cases/understanding_and_fixing_broken_requirement_branches.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Good explanation!