docs: actualize living docs to post-WP10 state (multi-doc audit)#12
Merged
Conversation
Audited the living docs against the current codebase and fixed stale references (historical records — ADRs, WP specs, backlog, spike results, blog, the dated reality-test snapshot — left intact by design). - 1-architecture-overview.md: add the Source Mapper agent; input layer is a declared YAML/JSON schema (+ profiling), not SQL/DDL; correct the HITL triggers to the real requires_signoff logic (validation error / unassigned contract owner); note MCP tools are notional (no registry yet); realign the ASCII box. - 2-multi-agent-design.md: 9-agent roster incl. Source Mapper; correct prompt paths (only the 5 LLM agents have prompts; deterministic agents have none); real graph topology (data_contract before modeling, source_mapper on the validated path, human_checkpoint, the re-model loop); 32 validator gates; state.flags not state.errors. - how-requirements-become-a-model.md: the two-input/mapping/staging/per-source-satellite "target" has shipped (WP7/WP9/WP10) — mark the gaps done, add source_mapper to the pipeline table, fix the "no source→target mapping" claim, refresh the status table. - health-insurance-walkthrough.md: eff-sat driving key is the policy (fixed side); generated model ADR is ADR-0001 not ADR-0004; transactional links ARE generated via automate_dv.t_link (no nh_link); figures marked representative + staging layer noted. - dv2-modeling-rules-spec.md: status note (implemented); dv2_rules.py no longer a "thin skeleton"; hierarchical links now representable (ADR-0009), only same-as deferred. - dv2-rules-cheatsheet.md: complete the validator-code table (19 → 32 codes); hierarchical links representable. - ireb-mapping.md: profiling is an implemented optional input, not "prospective". - dsaf-mapping.md: correct the generated-construct list (t_link, not "nh-links"). Also anglicized the remaining German prose term "Fachsprache" → "business vocabulary" (6 in how-requirements-become-a-model.md, 1 in ireb-mapping.md), consistent with the earlier Durchstich → "end-to-end PoC" rename. Intentional German domain terms in the reality-test/messy_insurance fixtures are left as-is. Documentation-only. Co-Authored-By: Claude Opus 4.8 (1M context) <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
1 participant
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
Audited the living docs against the current codebase and fixed stale references. Historical records (ADRs, WP specs, backlog, spike results, blog, the dated
reality-testsnapshot) were left intact by design.Accurate — no changes:
0-vision.md,competitive-landscape.md,data-contracts-approach.md.Fixed (8 files):
1-architecture-overview.md— add Source Mapper; input = declared YAML/JSON (+profiling), not SQL/DDL; correct HITL triggers to the realrequires_signofflogic; realign the ASCII box.2-multi-agent-design.md— 9-agent roster; correct prompt paths (only the 5 LLM agents have prompts); real graph topology (data_contract before modeling, source_mapper on the validated path, human_checkpoint, re-model loop); 32 gates;state.flagsnotstate.errors.how-requirements-become-a-model.md— the two-input/mapping/staging/per-source-satellite "target" has shipped (WP7/WP9/WP10): mark gaps done, addsource_mapperto the pipeline table, fix the "no source→target mapping" claim, refresh the status table.health-insurance-walkthrough.md— eff-sat driving key = policy (fixed side); generated model ADR isADR-0001notADR-0004; transactional links are generated viaautomate_dv.t_link(nonh_link); figures marked representative.dv2-modeling-rules-spec.md— status note (implemented); no longer a "thin skeleton"; hierarchical links now representable (ADR-0009), only same-as deferred.dv2-rules-cheatsheet.md— complete the validator-code table (19 → 32 codes); hierarchical links representable.ireb-mapping.md— profiling is an implemented optional input, not "prospective".dsaf-mapping.md— correct the generated-construct list (t_link, not "nh-links").Also anglicized the remaining German prose term "Fachsprache" → "business vocabulary" (7 occurrences), consistent with the earlier
Durchstich→ "end-to-end PoC" rename. Intentional German domain terms in thereality-test/messy_insurancefixtures are left as-is.Documentation-only.
🤖 Generated with Claude Code