docs: align the inception NFR category list with core (observability) - #761
docs: align the inception NFR category list with core (observability)#761warren830 wants to merge 1 commit into
Conversation
PR awslabs#404 made observability a first-class NFR category across the NFR stages, but docs/reference/04-stages/inception.md still documented the pre-awslabs#404 set. Two lists were stale: - Completeness Analysis dimension 2 omitted observability. - The requirements.md output description omitted BOTH reliability and observability, and did not carry core's stable `NFR{n}` ID instruction. Both now mirror core/aidlc-common/stages/inception/requirements-analysis.md verbatim. `docs/` is hand-authored and not projected into dist/, so package.ts --check never caught the drift and no test asserts these lines. Docs-only: no version bump per the AGENTS.md changelog policy. Refs awslabs#398
|
Warren, this PR corrects the two remaining stale NFR descriptions in the Part A - Direction: sound. I verified the current Part B - Review: one P2 at The category fixes themselves are correct. The pure-doc version-bump exemption Part C - UX impact: this corrects what reference readers are told; it does Request changes for the FR ID omission above. |
apackeer
left a comment
There was a problem hiding this comment.
Requesting changes for the FR ID documentation omission described in my review comment.
Summary
Closes the last gap from #398. The substance of that issue — observability missing from the NFR category set — was fixed on
v2by merged PR #404 ("feat: first-class observability artifacts across NFR stages",4e8f087c), which established the canonical five categories and theobservability-requirements → observability-design → monitoring-designartifact chain. The issue was never closed, and the docs reference still documents the pre-#404 set.Refs #398. Worth closing that issue once this lands — the reporter (@jeromevdl) authored the fix themselves and never got an acknowledgement.
Changes
docs/reference/04-stages/inception.md, two stale lists:observability.requirements.mdoutput description — omitted bothreliabilityandobservability, and did not carry core's stableNFR{n}ID instruction.Both now mirror
core/aidlc-common/stages/inception/requirements-analysis.md(lines 94 and 158) verbatim.User experience
A reader following the stage reference sees the same five NFR categories the stage actually produces. Previously the docs said four (or three), while
nfr-requirements.mdemitted five andstage-graph.jsoncarriedobservability-requirements.Why this drifted
docs/is hand-authored and not projected intodist/, sobun scripts/package.ts --checknever sees it and no test asserts these lines. That is why #404 could correct all fourcore/stage files plus all 7 harness trees and still leave the reference behind.I swept the rest of
docs/for the same pattern with a multiline-aware match (the lists wrap, so a plaingrepgives false hits):construction.mdandagents/architect-agent.mdalready carry the full five. This was the only stale file.Checklist
Test Plan
Docs-only, 3 lines. No version bump, CHANGELOG entry, or README badge — the AGENTS.md changelog policy exempts pure doc sweeps ("Pure doc sweeps, internal refactors, and test-only changes do NOT bump"), matching merged precedent (#733, #693, #651).
Verified locally (bun 1.3.11; CI pins 1.3.14):
Suite result is byte-identical to the pre-change baseline on this branch point: same 2 failing files (
t248-codekb-scope-diff,t255-workspace-sync— unrelated;t255's are ~5s timeouts on live git remote queries and look environmental here), same 9 assertions, same 6038 total. Added lines stay within the file's ~76-column wrap convention (72/32/72/76).The
docs.ymlbuild job will run on this PR since it touchesdocs/.Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.