Skip to content

Revised the Terms and definitions to comply with ISO - #139

Open
seanmcilroy29 wants to merge 1 commit into
devfrom
Revised-the-Terms-and-definitions-to-comply-with-ISO
Open

Revised the Terms and definitions to comply with ISO#139
seanmcilroy29 wants to merge 1 commit into
devfrom
Revised-the-Terms-and-definitions-to-comply-with-ISO

Conversation

@seanmcilroy29

Copy link
Copy Markdown
Collaborator

Revised the Terms and definitions to comply with ISO

Revised the Terms and definitions to comply with ISO

Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
@claude

claude Bot commented Jul 14, 2026

Copy link
Copy Markdown

Claude PR Review — PR 139 (Revised Terms & Definitions / Section 6 to comply with ISO)

Thanks for this cleanup. This is a documentation/spec repo, so I reviewed for editorial consistency, correctness of normative language, and alignment with FAQ.md per CLAUDE.md. The scope is Section 6 of SPEC.md only (Persona-based software boundary definition).

👍 What looks good

  • Replacing & with and throughout the section improves readability and is applied consistently within Section 6.
  • Rewording "The SCI for AI specification defines boundaries…""This document defines boundaries…" reads cleanly and does not conflict with FAQ.md (FAQ refers to the spec in the third person and its persona/boundary rationale is unaffected), so no companion FAQ update is required here. 👍

⚠️ Issues worth addressing

1. Normative keyword casing is now inconsistent across the document (highest priority). This PR lowercases the RFC 2119 / ISO-directive keyword SHALLshall in 6.1 and 6.2, but the rest of SPEC.md still uses uppercase normative keywords: SPEC.md:153, 157, 165, 169, 173, 177, 204, 220 (SHALL / MAY) and SPEC.md:183, 200, 204, 233 (SHOULD / MAY). Uppercase keywords carry defined normative meaning in a requirements spec. After this change, Section 6 is the only place using lowercase, which is easy to misread as non-normative. ISO/IEC directives do favour lowercase shall, so lowercasing may well be the right end-state — but it should be applied document-wide in one pass, not just in Section 6, otherwise the document is internally inconsistent. Recommend either (a) reverting Section 6 to uppercase for now, or (b) expanding the PR to lowercase all normative keywords consistently.

2. Heading case is now inconsistent with the rest of the spec. Section 6 headings were changed to sentence case ("Persona-based software boundary definition", "6.1 Consumer boundary", "6.2 Provider boundary"), while every other heading in SPEC.md remains Title Case (e.g. "5. AI Lifecycle Stages", "5.5 End of Life", "7. AI Life Cycle Coverage", "8.1 Consumer Functional Units"). Section 6 is now the lone outlier. If ISO sentence-case is the target, apply it across all headings; otherwise keep Section 6 in Title Case to match.

3. Trailing whitespace introduced on blank lines. Several of the newly added blank lines contain a trailing space (visible in the diff as a space after the + on the blank lines following each heading in Section 6). This is markdown-lint noise and adds no content — please strip the trailing spaces so the blank lines are truly empty.

Suggestion: Because issues 1 and 2 are about document-wide consistency, the cleanest path is to either keep this PR narrowly aligned to the surrounding style, or broaden it into a single "align Section 6 wording + apply ISO casing/keywords across the whole SPEC" change. A half-converted document is harder to reason about than a fully-Title-Case or fully-ISO one.


Automated review by Claude. Editorial judgment on ISO alignment ultimately rests with the working group.

@Henry-WattTime

Henry-WattTime commented Jul 31, 2026

Copy link
Copy Markdown

Reviewed and approved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants