OSCAL Schema style guide #616
Labels
Aged
A label for issues older than 2023-01-01
enhancement
Scope: Documentation
This issue relates to OSCAL documentation.
Scope: Modeling
Issues targeted at development of OSCAL formats
Describe the bug
Reviewing conventions and policies related to naming things in OSCAL (elements, objects, flags, fields, field values, grouping names) would help us provide models with more consistency and legibility.
Currently, to the extent that we have such rules, they are not always followed: for example why do we have both
desc
anddescription
?Who is the bug affecting?
Everyone who uses OSCAL will benefit by consistency and clarity in names.
Expected behavior (i.e. solution)
Let's agree and document on a set of rules or principles to follow when naming things in the model. This could be done in the context of a style guide, also addressing other issues e.g. #615.
Then we should review models and improve naming where appropriate.
Rules we have in mind including things like "all lower case", "hyphens to demarcate parts of names (not dots or underscores)" (less controversial rules of thumb) but also, when full names (
description
) or abbreviated forms (desc
) are better.The text was updated successfully, but these errors were encountered: