Skip to content

EARS authoring guidance in FR/NFR/StR skeletons (FR-042) #5

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

Merged
kreneskyp merged 1 commit into from
Jun 23, 2026
Merged

EARS authoring guidance in FR/NFR/StR skeletons (FR-042) #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions spec_artifacts_iso/skeletons/fr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,15 @@ relationships:
(ADR 0007) — so they become real graph edges, not text. Cross-repo
references use `ix://org/repo/name`. `quire fix` converts bare-id
mentions into these relative-path links for you.
- Requirement statements (Description, Behavior, Constraints cells)
SHOULD follow EARS (advisory grammar `iso-spec-core`, FR-042): one
`shall` per statement, a named subject, and a concrete response —
avoid vague verbs (`support`/`handle`/`manage`/`process`/`provide`/
`enable`). When conditional, lead with a canonical trigger:
`When <event>, the <system> shall …` (event) / `While <state>, …`
(state) / `If <cond>, then the <system> shall …` (unwanted) /
`Where <feature>, …` (optional) — NOT `On startup, …`. `quire
validate` warns on violations; the warnings never block.
- Keep headings unique per level; nest ≤2 levels below the H1 title
(through H3). -->
# [FR-001] Verify checksums on artifact import
Expand Down
5 changes: 5 additions & 0 deletions spec_artifacts_iso/skeletons/nfr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ relationships:
IS the NFR's acceptance-criteria equivalent; use the optional
Acceptance Criteria section only for policy NFRs whose
compliance checks don't reduce to metrics.
- The Statement SHOULD follow EARS (advisory grammar `iso-spec-core`,
FR-042): one `shall`, a named subject, a concrete response. NFRs are
typically ubiquitous or state-driven (`The system shall sustain …
while under load`); a trigger is not required and its absence is
never a defect. `quire validate` warns on violations (never blocks).
- Keep headings unique per level; nest ≤2 levels below the H1 title
(through H3). -->
# [NFR-001] Import throughput under sustained load
Expand Down
5 changes: 4 additions & 1 deletion spec_artifacts_iso/skeletons/str.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ relationships:
Constraints (Contextual), Dependencies, Priority and Risk
(Informative), Notes (Informative), Traceability.
- State the need normatively (shall/must/require) — a `str-shall-language`
lint advisory checks this.
lint advisory checks this. The need SHOULD also follow EARS (advisory
grammar `iso-spec-core`, FR-042): one `shall`, a concrete response;
the subject may be the stakeholder or product (`The operator shall
…`), not only "the system". `quire validate` warns on violations.
- Keep headings unique per level; nest ≤2 levels below the H1 title. -->
# [StR-001] Operators need tamper-evident artifact imports

Expand Down