There are numerous instances of informal pronouns within the document, they need to be changed before submitting to ISO.

We:
Sec 4 pg 2 para 2
Sec 10.1 pg 11 para 1, para 3
Sec 10.3 pg 12 para 1
Sec 12.5 pg 24 para 2 (2)
Sec 12.5 pg 25 para 2
Sec 12.6.2 pg 29 para 1 (3)
Sec 12.7 pg 30 para 4 (2)
Sec 16.1 pg 39 para 2, para 3
Sec B.3 pg 43
Sec B.4 pg 43
Sec B.5 pg 43 (2)

Our:
Sec 10.1 pg 11 para 3
Sec 16.1 pg 39 para 2
Sec B.5 pg 43

Fix informal pronouns to prepare for ISO Submission

Minimally invasive languages changes here, any further changes that collide with this will be dealt with as needed.

Any changes required for meeting style and organizational requirements for OMG and ISO formatting.

This issue should generate NO CONTENT CHANGES. No change should be included here that alters the meaning of the specification, only the formatting and document structure.

Any changes that may alter the interpretation of the material (italicization, camelCaps, etc) need to be addressed in their own issue(s).

Add any identified issues as comments below for the moment.

Administrative editorial changes

These proposed changes are strictly editorial in nature and do not change the meaning or intent of any text within the specification. If anyone notices something that they feel would change the interpretation or meaning of anything, please raise a concern immediately so it can be resolved.

The definitions in Terms & Definitions need to be reworked not so much for content, but for formatting. See both ISO / IEC 2018 Directivess Part 2, 2018 Clause 16, as well as Nick Stavros' EBC review of SPMS 1.3 June 5 2024.

New 'in place substitution' appropriate definitions need to be written, with the existing text bumped to Note status in some cases.

Update definitions to ISO format

Mostly formatting oriented, this will require some changes to the actual text.

Subclauses 12.3 and 12.6 have hanging paragraphs (content between the title and the first subsubclause). These are not allowed by ISO, and need to be resolved before PAS submission. This will renumber the subsequent subsubclauses and may require changing references to them elsewhere.

Resolve Hanging Paragraphs in 12.3 and 12.6

Place hanging material in 12.3 and 12.6 into 12.3.1 and 12.6.1 respectively, triggering renumbering of subsequent subclauses.
Update references to these subclauses as needed.

There are four equations in the document, none are numbered. Consider numbering them for more clear reference.

Clause 8.1 pg 7, para 3, 5
Clause 9.1 pg 10, para 3, 5

No change to numbering equations

There are four equations that are candidates for numbering:
Clause 8.1 pg 7, para 3, 5
Clause 9.1 pg 10, para 3, 5

None are referenced elsewhere.

ISO / IEC Directives, Part 2, Clause 27.3 states:
"If needed for cross-referencing purposes, mathematical formulae can be numbered in a document."

Since these are not cross-referenced, no numbering is required.

Clause 5 Symbols is empty, only a declaration that the document defines none.

By both OMG and ISO requirements this is unnecessary.

Deleting this Clause, will, however, renumber the remainder of the document, making tracking of other issues more difficult.

Delete Clause 5 - APPLY LAST

Delete Clause 5 as unnecessary.

Since this will trigger a renumbering of the remainder of the document, apply this fix LAST to help with issue tracking.

Middle of first paragraph, "Design Patterns" is both italicized and underlined. Remove underlining.

Remove underlining of book title

Sec 8.5, pg. 12 (spec PDF page 20), the book title Design Patterns needs the underlining removed.

ISO-IEC Directives Part 2, Sec 22.3.3 indicates that no content should appear between a Clause title and the first Subclause, if it exists.

https://isotc.iso.org/livelink/livelink/fetch/2000/2122/4230450/4230456/ISO_IEC_Directives%2C_Part_2%2C_Principles_and_rules_for_the_structure_and_drafting_of_ISO_and_IEC_documents_-_2018_%288th_edition%29_-_PDF.pdf

Section 14 has as paragraph and figure prior to 14.1 Move that content to 14.1, and adjust remainder of Section 14 subsections accordingly.

Added Section 14.1 heading title

Added "14.1 Introduction" title to content immediately after Section 14 header. Remainder of Section 14 subsection numbering adjusted accordingly.

This is a very convoluted diagram, and may benefit from providing multiple instances of both RES::Field and RES::Method at the top to help reduce the number of crossing lines.

Reworked Fig 16.1 for clarity

Moved items around for better spatial arrangement. No content changes.

Section 12.6 discusses Multiplicity of PINboxes and Equalities, but does so a bit oddly. While it may have made sense to discuss the topic in one place, the effects are seen in PINbox, Equality, and BindingGlyph classes. It probably makes more sense (particularly for PINbox, where the Stacked view is dependent not on an explicit enum, but on an implicit multiplicity of its instances association), to move this discussion into the relevant sections.

Only moving the PINbox discussion would be acceptable, but clarifying text ought to be added to Equality and BindingGlyph as well.

Leaving the bulk of the Equality and BindingGlyph discussion in Sec 12.6 would then make sense, and it, coupled with Sec 12.7, would make for a good set of topics for guidance on visualization techniques that do not directly rely on the metamodel. (Peeling & Coalescing in particular is a UX behavior that does not currently have a reflection in the metamodel.)

Provided forward pointing hints, instead of moving sections.

While moving the Multiplicity sections was an option, no edits were satisfying, and instead this approach makes the minimal change that accomplishes much of the same goal.

A forward hint is added to each of Sections 12.3, 12.4 and 12.5 that refer to Section 12.6. These inform the reader of an additional twist to each situation, that will be discussed in detail in 12.6.

The association 'equivalents' of the Equality class is missing any textual description.

Add required description.

Section 12.4, page 33 (spec PDF page 33) Added descriptive text to 'equivalents' association in Equality class.

Figure 12.1 - PIN Module: Equality class does not show the style : MultiplicityStyle attribute indicated in the text in Section 12.4. The text is correct.

Fixed Figure 12.1 to add attribute to Equality class

Added indicated attribute to Equality class

In Figure 8.1 - Definitions Package, there is a directed association from PatternElement to Formalisms::FormalizedDefinition.

This should be coming from PatternDefinition. The text in Section 8.3 PatternDefinition is correct, the figure is not.

Modified Figure 8.1 as needed

Moved the root of the directed association to SPMS:Formalisms:PatternDefinition from PatternElement, to PatternDefinition, to match the correct text in Sec 8.3.

First line under definition of term Pattern:

"Desing Patterns, Gamma et al."

Desing -> Design

Italicize "Design Patterns" as title of book.

Fixed listed typos

Title of book misspelled, and not italicized.

The PatternSection class currently only allows a simple string for the body attribute. It would be much more useful if it were to allow any MOF::Element based entity to represent the body. This would allow for not only richer text, but also diagrams, a remote URI (as a structured URI, not just a string), or other expression.

Note that the image in Figure 8.1 and the XMI file in SPMS 1.2 were both correct, this only affects the prose in Section 8.5.

Redefine PatternSection:body as a MOF::Element

PatternSection:body will be an attribute of type MOF::Element instead of string. This requires changing both the descriptive text in Section 8.5 and Figure 8.1 to match.

Update Diagram Definition reference in the first line of second paragraph to 1.1.

Update DD 1.0 to 1.1

Update numeric reference.