Skip to content

Update big-use-case-user-story.md #2

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.

Sign up for GitHub

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

Open
sfolsom wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update big-use-case-user-story.md #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3bb9e6f
Update big-use-case-user-story.md
sfolsom Aug 7, 2025
5de30ec
Update big-use-case-user-story.md
sfolsom Sep 4, 2025
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
16 changes: 8 additions & 8 deletions .github/ISSUE_TEMPLATE/big-use-case-user-story.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,32 @@ assignees: ''

## Use case overview
- **Priority**: [High/Medium/Low]
- **Status**: [Draft/Under Review/Approved/Implemented]
- **Status**: [Use appropriate GitHub label when creating Issue, e.g. question, help wanted, Ready for Review]

## Describe use case
A clear and concise description of a use case supported by BIG outputs (DCTAP and/or SHACL).
_A clear and concise description of a use case supported by BIG outputs (DCTAP and/or SHACL)._

E.g. *As a cataloger using a BIBFRAME editor, I would like the editor to check that my description validates using the BIG shapes without any errors*

## Preconditions (Optional)
List conditions that must be true before this use case can begin.
_List conditions that must be true before this use case can begin. Please list any known blockers for this use case._

## Describe expected behavior in related systems
A clear and concise description of related system behavior
_A clear and concise description of related system behavior_

E.g. *Using the BIG SHACL, the editor would compare the description provided by the cataloger against the applicable BIG SHACL before saving the data. If the description does not confirm to BIG shape definitions, the cataloger would not be allowed to save the description and would be notified which fields in the editors are missing or require changes*

## Post conditions (Optional)
### Success post conditions
What should be true after successful completion?
_What should be true after successful completion?_

### Failure post conditions
What should be true if the use case fails?
_What should be true if the use case fails?_

## Main success scenario
What steps or conditions would this use case be considered to be a success?
_What steps or conditions would this use case be considered to be a success?_

## Additional context
Add any other context or screenshots about the features you are requesting.
_Add any other context or screenshots about the features you are requesting._

E.g. *Using SHACL for validation in BIBFRAME editors like Sinopia and Marva has overlap with template creation in those systems*