formwork.md: requirement-quality pass against the authoring style guide - #26
Merged
Merged
Conversation
Audited all 76 FW-<FAMILY><n> requirements and the 11 invariants against the
constitution's Requirements authoring section, beyond the earlier banned-word
sweep. Fixes for the genuine deviations found:
- FW-GW7: replace the bare deferring word "minimal" ("its own filesystem scope
is minimal") with a verifiable bound — access scoped to its policy input and
the stdio backends it spawns, not the host at large.
- FW-XR9: tighten the in-cell discussion, dropping two "real"-as-intensifier
uses ("a wall that isn't real" / "a feature that isn't real") for what the
mechanism does ("a wall it cannot install" / "a feature it cannot deliver").
- "real network" → "host network" (FW-XR5, FW-GW7, §2) — the precise term;
bare "real" is a banned intensifier. The other "real X" uses (real kernel /
Seatbelt / workload / filesystem) keep the genuine-vs-mock sense the
constitution's Testing section preserves.
- Bold is reserved for defined terms, parameter names, and table keys: drop
emphasis-bold from logical "and" (6x), "not create", "never", and a
whole-clause emphasis; the two safety-critical "not" negations in §1/§9
become italic, the doc's sanctioned emphasis mechanism.
Verification: every requirement ID resolves in the §10 traceability table;
test_requirements.py passes.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011agPfWKjH7H2oDaqiZyvnz
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.
Follow-up to the constitution reconciliation (#25, merged). That work removed banned words and metaphors; this pass audits every requirement in
formwork.mdagainst the constitution's Requirements authoring section for quality beyond word-swaps, and fixes the genuine deviations.Scope of the audit
All 76
FW-<FAMILY>nrequirements + 11 invariants were checked against the binding-statement shape (verifiable, single obligation, quantified values, genuine parent) and the prose-style rules (no intensifiers/self-description, bold reserved for defined terms/parameters/table keys). Verdict: conformant after the fixes below.Changes
its own filesystem scope is minimal) with a verifiable bound: access scoped to its policy input and the stdio backends it spawns, not the host at large.real-as-intensifier uses (a wall that isn't real/a feature that isn't real) for what the mechanism does (a wall it cannot install/a feature it cannot deliver).real network→host network(FW-XR5, FW-GW7, §2) — the precise term; bare "real" is a banned intensifier. The otherreal Xuses (real kernel/Seatbelt/workload/filesystem) keep the genuine-vs-mock sense the constitution's Testing section preserves.and(6×),not create,never, and a whole-clause emphasis; the two safety-criticalnotnegations in §1/§9 became italic, the doc's sanctioned emphasis mechanism.Verification
py/harness/test_requirements.pypasses (ID/anchor/link canary).Accepted as conformant (judgment calls, flagged for review)
Enforce filesystem read scope…). The §5.3 heading names the confiner as the actor, and the constitution endorsesformwork.md's compact table over the heavyweight per-requirement template, so these were left as-is rather than rewritten toThe confiner shall….equivalent(FW-XR6→E2E-028),permissive enough(FW-ISO8→TRA2),in the common case(FW-TRA2), low-overhead/responsive(FW-TRA6→§8's numeric targets) — left as-is; each has a checkable criterion.🤖 Generated with Claude Code
Generated by Claude Code