notations: add IDs and cross-references appendix#8
Merged
Conversation
`notations/IDS_AND_REFERENCES.md` is the canonical place for the ID grammar and TYPE registry used across all eleven notations. Before this PR the rules were scattered: each spec invented its own style, examples mixed integer IDs, abbreviated prefixes (ACT, CHG, FAC, CAP, SCN), and zero-padded sequences; the same TYPE was sometimes written several ways across files. The appendix carries: - The canonical grammar `<TYPE>-[<middle segment(s)>-]<INTEGER>`, with the rule that the terminal integer is positive, no leading zeros, and sorted numerically. - The `CAPABILITY` exception (V/H diagram address replacing the terminal integer, depth capped at three levels). - The complete TYPE registry — element types (FACTOR, GOAL, CHANGE, ACTIVITY, CAPABILITY, PROCESS, PRODUCT, APPLICATION, INTEGRATION, ROLE, UNIT, EMPLOYEE, SCENARIO) and document-level prefixes (FGCA, FGA, GOALS_TREE, …). BPMN file-local labels (POOL, TASK, GW, …) are explicitly out of scope. - Uniqueness scope per TYPE. - The cross-reference pattern (plural field → array of typed IDs). - A migration checklist documenting which existing files still use old forms (ACT-, CHG-, FAC-, CAP-, SCN-, integer-only, zero-padded). Migration itself is out of scope per the issue refinement; per- notation follow-ups will do it gradually. Eight specs (03, 04, 05, 06, 07, 09, 10, 11) gain a one-line link to the appendix in their References section. 01-bpmn (file-local labels only) and 08-blocks (no IDs) intentionally do not link. 02-fgca will gain the link when its schema lands (#7 in flight). Refs: vkgeorgia/strategy#13 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
notations/IDS_AND_REFERENCES.mddefines the canonical ID grammar<TYPE>-[<middle segment(s)>-]<INTEGER>, documents theCAPABILITYV/H exception, enumerates the complete TYPE registry (element types + document-level prefixes), states uniqueness scope per TYPE, the cross-reference pattern, and a migration checklist for files still using old forms.03,04,05,06,07,09,10,11) gain a one-line link to the appendix in their References section.Closes vkgeorgia/strategy#13.
Scope guard
Per the issue refinement, this PR produces only the new appendix file and adds a cross-link from each spec that references IDs. No other spec content changes; no example rewrites; no audit items.
Which specs are linked vs not
01-bpmnuses only file-local labels (POOL, TASK, GW…), explicitly noted as out of scope in the appendix §3.3.02-fgcaon main has no schema and therefore no IDs yet; it will gain the link as part of transitrix/methodology#7 which introduces its schema.08-blocksuses ASCII art with no element IDs.Migration
The appendix carries a migration checklist documenting which existing files still use old ID forms (
ACT-,CHG-,FAC-,CAP-,SCN-, integer-only IDs, zero-padded sequences). The migration itself is out of scope — per-notation follow-ups will do it gradually. The integer-IDs row in the FGCA example is already in flight via #7.Test plan
notations/IDS_AND_REFERENCES.mdexists with all seven sections (Grammar, Capability exception, TYPE registry, Uniqueness scope, Cross-references, Migration checklist, References).vkgeorgia/strategyrepo in any shipped file.🤖 Generated with Claude Code