Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OSCAL Schema style guide #616

Open
wendellpiez opened this issue Jan 29, 2020 · 2 comments
Open

OSCAL Schema style guide #616

wendellpiez opened this issue Jan 29, 2020 · 2 comments
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

Comments

@wendellpiez
Copy link
Contributor

wendellpiez commented Jan 29, 2020

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 and description?

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.

@wendellpiez
Copy link
Contributor Author

I plan to survey the models, write up a list of ideas (possibly on this Issue) and circulate.

@wendellpiez wendellpiez self-assigned this Jan 30, 2020
@david-waltermire david-waltermire self-assigned this May 22, 2020
@wendellpiez wendellpiez changed the title Naming rules? OSCAL Schema style guide Jun 4, 2020
@david-waltermire david-waltermire added the Scope: Modeling Issues targeted at development of OSCAL formats label Oct 30, 2020
@david-waltermire david-waltermire added Scope: Documentation This issue relates to OSCAL documentation. and removed bug labels Mar 15, 2021
@aj-stein-nist aj-stein-nist removed this from the OSCAL 1.1.0 milestone Jul 27, 2023
@aj-stein-nist
Copy link
Contributor

The team reviewed this and believe it is still useful, and given previous issues regarding Metaschema liniting with Schematron, it seems viable and timely. Will consider for review in upcoming sprints.

@aj-stein-nist aj-stein-nist moved this from Todo to Needs Refinement in NIST OSCAL Work Board Sep 21, 2023
@Compton-US Compton-US added the Aged A label for issues older than 2023-01-01 label Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
Status: Needs Refinement
Development

No branches or pull requests

4 participants