Skip to content

docs(notations): decision guide for connecting REQUIREMENT records - #518

Merged
transitrix merged 2 commits into
mainfrom
methodology/303-requirement-connection-decision-guide
Aug 24, 2026
Merged

docs(notations): decision guide for connecting REQUIREMENT records#518
transitrix merged 2 commits into
mainfrom
methodology/303-requirement-connection-decision-guide

Conversation

@transitrix

Copy link
Copy Markdown
Owner

Summary

  • Adds a compact decision guide (15-requirement.md §2.4.1) distinguishing parent, depends_on, and required_for for connecting REQUIREMENT records, each with a one-line use/avoid rule.
  • Cross-links the guide from the relation registry (17-relations.md §3), which now states explicitly that parent is an inline alternative to the REL kinds registered there, not a gap in the enum.
  • Documentation only — clarifies existing normative text, no new field/TYPE/validator rule. node scripts/check-notations.mjs passes clean (2 pre-existing unrelated SIZE1 warnings).

Test plan

  • node scripts/check-notations.mjs — clean
  • Verified existing depends-on/required-for worked examples already use the declared mechanisms consistently (no parent misuse found)

A reader landing on the depends_on/required_for relation-kind registry
had no discoverable pointer to REQUIREMENT.parent, the inline
alternative to both. Add a compact use/avoid table (15-requirement.md
§2.4.1) distinguishing parent, depends_on, and required_for, and
cross-link it from the relation registry (17-relations.md §3).

Documentation only — clarifies existing normative text; no new field,
TYPE, or validator rule.

Signed-off-by: transitrix <automation@transitrix.com>
Signed-off-by: transitrix <automation@transitrix.com>
@transitrix transitrix added the needs:human-merge Mergeable but not a simple PR; awaits human merge label Aug 24, 2026
@transitrix
transitrix merged commit 8575e73 into main Aug 24, 2026
10 checks passed
@transitrix
transitrix deleted the methodology/303-requirement-connection-decision-guide branch August 24, 2026 18:39
transitrix added a commit that referenced this pull request Sep 2, 2026
…#517, epic #503 slice 1/2)

Extends the existing freshness-decay mechanism (CONTRACT §11.3) and FRESHNESS-001 rule
(§11.7) to cover knowledge objects in addition to canonical elements:

Changes:
- CONTRACT.md §11.3: Documented freshness anchoring for knowledge objects
  - Canonical elements anchor on admitted_at (existing behavior)
  - Knowledge objects anchor on timestamp (new)
  - Single default threshold pair for knowledge objects (no per-TYPE tables)
  - Configuration example added showing knowledge: sub-key in confidence_decay

- CONTRACT.md §11.7: Extended FRESHNESS-001 rule
  - Covers both canonical elements (age_days >= stale_days for their TYPE)
  - And knowledge objects (age_days >= stale_days for knowledge threshold)
  - Cure differs: re-admission for canon, re-curation for knowledge objects
  - Advisory only (never blocks, mutates, or filters)

- MANIFEST.md: Updated confidence_decay documentation and example
  - Added optional knowledge: configuration sub-map
  - Clarified per-TYPE thresholds for canon, single threshold for knowledge
  - When knowledge: absent, defaults apply

Acceptance criteria met:
- Validator pass over stale knowledge objects names them (FRESHNESS-001)
- Store with no stale objects stays silent (negative case)
- Neither pass writes files (advisory only)
- Additive only; existing repositories validate unchanged

Not yet implemented in validator (that's a runner concern); spec establishes the
contract. Paired with task #518 (supersession); together close epic #503 Part 1-2.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Signed-off-by: transitrix <automation@transitrix.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs:human-merge Mergeable but not a simple PR; awaits human merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant