diff --git a/EDITORIAL_GUIDELINES.md b/EDITORIAL_GUIDELINES.md index 947acde16..29e7cbab1 100644 --- a/EDITORIAL_GUIDELINES.md +++ b/EDITORIAL_GUIDELINES.md @@ -3,7 +3,6 @@ The "Editorial Style Guidelines" section ensures consistency and clarity across These guidelines can be modified through a Pull Request (PR), which the members must review and agree upon. This process ensures that any changes are thoughtfully considered and maintains the overall integrity of our editorial standards. - @@ -12,27 +11,26 @@ These guidelines can be modified through a Pull Request (PR), which the members - + @@ -41,28 +39,44 @@ These guidelines can be modified through a Pull Request (PR), which the members + + + + + +
ComponentEditorial Guidelines
Column & Attribute Names:Column & Attribute Names: Column Names:
- - Pricing Quantity
- - Pricing Unit
- - Provider

+ - Pricing Quantity
+ - Pricing Unit
+ - Provider

Attribute Names:
- - Currency Code Format
- - Date/Time Format + - Currency Code Format
+ - Date/Time Format 		- Column Names:
-    **Pricing Quantity**
-    **Pricing Unit**
-    **Provider**

+ Column Names:
+    Pricing Quantity
+    Pricing Unit
+    Provider

Attribute Names:
-    **Currency Code Format**
-    **Date/Time Format**
+    Currency Code Format
+    Date/Time Format
 - - Bold
- Use the display name in the non-normative section.
- The first occurrence in a section is linked to the section. 		Column & Attribute IDs: Columns IDs:
- - PricingQuantity
- - PricingUnit
- - ProviderName

+ - PricingQuantity
+ - PricingUnit
+ - ProviderName

Attributes IDs:
- CurrencyCodeFormat
- DateTimeFormat
- Columns IDs::
+ Columns IDs:
   PricingQuantity
-    PricingUnit
-    ProviderName

+    PricingUnit
+    ProviderName

Attributes IDs:
   CurrencyCodeFormat
   DateTimeFormat
- - Use PascalCamel case (the first letter of every word, is capitalized) + - Use PascalCamel case (the first letter of every word, is capitalized)
- Normal text without bold or italics.
- The first occurrence in a section is linked to the section.
Column Values: + - "Usage"
+ - "Tax"
+ - "TB"
+ 		+ This column:
+    * MUST be null when ChargeCategory is "Tax" ... + 		+ - Enclosed in double quotation marks
+ - Normal text without bold or italics +
Normative Keywords & Statements @@ -130,21 +144,26 @@ These guidelines can be modified through a Pull Request (PR), which the members * **Normative Requirements as a Bullet List**: Normative statements (those using Normative Keywords) should be written as bullet points instead of lengthy sentences. +* **Column IDs:** They SHOULD be used in normative text sections, such as when specifying mandatory rules, schema definitions, or other implementation-related content. These Column IDs should be formatted without spaces and should match the exact naming conventions used in the schema (e.g., CommitmentDiscountID). + +* **Display Names:** They SHOULD be used in introductory or explanatory sections where natural language context is more appropriate. In these sections, display names should follow normal text conventions, including spaces between words (e.g., Commitment Discount ID). + + ### Example > **2.28. Pricing Quantity** > -> The **[Pricing Quantity](#pricing-quantity)** represents the volume of a given [SKU](#glossary:sku) associated with a [resource](#glossary:resource) or [service](#glossary:service) used or purchased, based on the **[Pricing Unit](#pricing-unit)**. Distinct from **[Consumed Quantity](#consumed-quantity)** (complementary to **[Consumed Unit](#consumed-unit)**), it focuses on pricing and cost, not resource and service consumption. +> The Pricing Quantity represents the volume of a given SKU associated with a [*resource*](#glossary:resource) or [*service*](#glossary:service) used or purchased, based on the [Pricing Unit](#pricingunit). Distinct from [Consumed Quantity](#consumedquantity) (complementary to [Consumed Unit](#consumedunit)), it focuses on pricing and cost, not *resource* and *service* consumption. > > * The PricingQuantity column MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset). -> * This column MUST be of type Decimal and MUST conform to Numeric Format requirements. -> * The value MAY be negative in cases where ChargeClass is "Correction". +> * This column MUST be of type Decimal and MUST conform to [Numeric Format](#numericformat) requirements +> * The value MAY be negative in cases where [ChargeClass](#chargeclass) is "Correction". > > This column: -> * MUST NOT be null when ChargeClass is not "Correction" and ChargeCategory is "Usage" or "Purchase", +> * MUST NOT be null when [ChargeClass](#chargeclass) is not "Correction" and [ChargeCategory](#chargecategory) is "Usage" or "Purchase", > * MUST be null when ChargeCategory is "Tax", and > * MAY be null for all other combinations of ChargeClass and ChargeCategory. -> * When unit prices are not null, multiplying PricingQuantity by a unit price MUST produce a result equal to the corresponding cost metric, except in cases of ChargeClass "Correction", which may address PricingQuantity or any cost discrepancies independently. +> * When unit prices are not null, multiplying PricingQuantity by a unit price MUST produce a result equal to the corresponding cost metric, except in cases of ChargeClass "Correction", which may address PricingQuantity or any cost discrepancies independently. > > **2.28.1. Column ID** > @@ -156,7 +175,7 @@ These guidelines can be modified through a Pull Request (PR), which the members > > **2.28.3. Description** > -> The volume of a given SKU associated with a resource or service used or purchased, based on the Pricing Unit. +> The volume of a given SKU associated with a *resource* or *service* used or purchased, based on the Pricing Unit. > > **2.28.4. Content Constraints Constraint** >