AICC / CMI-5_Spec_Current

cmi5
http://adlnet.gov
Apache License 2.0
181 stars 91 forks source link

#773 1.2 document style conventions #777

Closed MartinKoob closed 1 year ago

MartinKoob commented 1 year ago

This is my first draft at the section 1.2 Document Style Conventions. This is the explanation of the document style conventions based on discussions in the working group on Jan 27, 2023 minutes. https://github.com/AICC/CMI-5_Spec_Current/wiki/CMI-5-Working-Group-Meeting-Minutes-–-January-27th%2C-2023

This also includes a reference to Section 1.2 in the Table of Contents. Within it is a link to another section.

MartinKoob commented 1 year ago

I made the changes to the code in section 1.2 based on the feedback from the cmi5 Working group meeting - Feb 24, 2023

Please review to make sure I captured all the suggested revisions correctly.

I have a couple of questions:

Q1.

I deleted the following from the explanation of Back Ticks:

  • do not use bold/italic styling on verb & properties in text descriptions (use back ticks instead)

QUESTION 1: Should that have been totally deleted or moved elsewhere in section 1.2? As I remember it that was just an explanation to the group of the intent of the change.

Q2.
Under the heading Style Conventions I made some punctuation changes.

QUESTION 2: Should I change that to commas with a period after the last list item or punctuate another way?