docs(dummies): add the architecture and design audit report - #227
Merged
Conversation
Full audit of the Dummies library at revision 3bf89e3: strengths and weaknesses, quality review and compliance check of the eight applicable ADRs (0006, 0011, 0013, 0015, 0020, 0022, 0025, 0026), architecture, API, and maintainability reviews, a classified feature-gap analysis, and a pre-release roadmap. Documents three runtime-reproduced defects (AnyDecimal upper-half unreachability, Single/Half exclusion-nudge stall, regex U+FFFF class-range hang) with evidence and proposed fixes. Advisory per ADR-0004; all proposals are drafts for the maintainer. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GvrWFVoG74xiys3oyEft1G
Add the French sibling of the Dummies architecture and design audit, matching the repository's bilingual documentation convention, and add reciprocal language navigation links to both files. Faithful translation of the English canonical document; no findings changed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GvrWFVoG74xiys3oyEft1G
Add a static "Issue tracking" section (§14) to the Dummies architecture audit, EN and FR in lockstep, mapping each §11 recommendation to the GitHub issues opened from it (#206-#226) and the §12 roadmap phase. The table is a snapshot; live issue status stays in the tracker. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GvrWFVoG74xiys3oyEft1G
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
Adds the 2026-07-20 architecture & design audit of the standalone
Dummieslibrary — a maintainer-facing report underdoc/handwritten/for-maintainers/audit/, in English (canonical) and French in lockstep. Documentation-only; no source or behavior changes. The audit is advisory per ADR-0004; its recommendations were opened as issues #206–#226, cross-referenced from §14.Type of change
Changes
doc/handwritten/for-maintainers/audit/2026-07-20-dummies-architecture-and-design-audit.md— the full audit (13 review sections: executive summary, assessment, strengths, weaknesses, ADR review & compliance, architecture, API, maintainability, feature-gap analysis, recommendations, roadmap, conclusion), documenting three runtime-reproduced defects (AnyDecimal upper-half unreachability, Single/Half exclusion-nudge stall, regex U+FFFF class-range hang) with evidence and proposed fixes.…-audit.fr.md, a faithful translation, with reciprocal language navigation links on both files.Testing
dotnet build FirstClassErrors.slndotnet test FirstClassErrors.slnFirstClassErrors.Analyzers.UnitTests)Documentation-only change — no source modified, so the solution build and tests are unaffected and were not re-run for this PR. The Dummies unit suite was executed during the audit itself (
dotnet test Dummies.UnitTests→ 222/222 passing on the net10.0 runner) and is unchanged here.Documentation
doc/updatedThe audit lives under
doc/handwritten/for-maintainers/; the English document is canonical and the French translation is kept in lockstep perCLAUDE.md. No public API or user-facing behavior changes, so nofor-usersdocs or NuGet READMEs are touched by this PR (the audit recommends such doc work in follow-up issues #218/#219).Architecture decisions
Proposed: ADR-____This PR records no ADR. The audit reviews the existing Dummies ADRs (0006, 0011, 0013, 0015, 0020, 0022, 0025, 0026) for quality and compliance, and recommends drafting two new
ProposedADRs (a determinism-contract ADR and an ordinal-engine ADR) — tracked in issues #216 and #217, to be drafted in their own changes.Related issues
Opened from this audit (§14) — not closed by this PR:
🤖 Generated with Claude Code
https://claude.ai/code/session_01GvrWFVoG74xiys3oyEft1G
Generated by Claude Code