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

Add documentation for recognized part names #550

Closed
3 tasks
bradh opened this issue Dec 1, 2019 · 2 comments
Closed
3 tasks

Add documentation for recognized part names #550

bradh opened this issue Dec 1, 2019 · 2 comments
Assignees
Labels
Discussion Needed This issues needs to be reviewed by the OSCAL development team. enhancement model-refactor Used to mark issues related to model refactoring for the Metaschema v4 transition. Scope: Documentation This issue relates to OSCAL documentation. Scope: Modeling Issues targeted at development of OSCAL formats User Story

Comments

@bradh
Copy link
Contributor

bradh commented Dec 1, 2019

User Story:

As an OSCAL producer or consumer, I want to know what the "recognized names" for the name within a part are, so that I can used shared understanding, or know if I need to add a ns.

The documentation for name includes:

The definition of a name is subject to its namespace, offered by an ns flag (q.v.). When ns is not given, the namespace is assumed to be "oscal" and the name should be one of the recognized values for names in OSCAL.

However I don't see what the "recognized values" are.

Goals:

Update the documentation to include those recognized values - link to this part of the documentation, if (already) included somewhere else.

As a possible enhancement, add validation checks that either the name is one of the recognized values, or a distinct ns is provided for the part.

Dependencies:

None identified.

Acceptance Criteria

  • All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
@bradh
Copy link
Contributor Author

bradh commented Dec 8, 2019

From : $ ack --no-filename \<part content/nist.gov/SP800-53/rev4/xml/*.xml | ack -v party | cut -d \" -f 2,4 | rev | cut -d \" -f 1 | rev | sort | uniq I see:

assessment
guidance
item
objective
objects
statement

"objects" appears to be only used within "assessment" for identifying parts of the assessment process. That might be less than ideal for the "INTERVIEW" part, where we're talking about groups of people.

Similarly, "item" appears to be only used within "statement" for identifying sub- (and sub-sub-) parts of the control requirement.

"objective" appears to be used for higher level outcome goals (including within other "objective" parts). Distinction between "statement" and "objective" isn't yet clear.

"guidance" is used for informative ("scene setting" or background) text.

@david-waltermire david-waltermire added Discussion Needed This issues needs to be reviewed by the OSCAL development team. Scope: Modeling Issues targeted at development of OSCAL formats Scope: Website Issues targeted at the OSCAL project website. Scope: Documentation This issue relates to OSCAL documentation. and removed Scope: Website Issues targeted at the OSCAL project website. labels Jan 9, 2020
@david-waltermire david-waltermire added the model-refactor Used to mark issues related to model refactoring for the Metaschema v4 transition. label Sep 11, 2020
@david-waltermire david-waltermire self-assigned this Oct 30, 2020
@david-waltermire
Copy link
Contributor

This issue was addressed by PR #758.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion Needed This issues needs to be reviewed by the OSCAL development team. enhancement model-refactor Used to mark issues related to model refactoring for the Metaschema v4 transition. Scope: Documentation This issue relates to OSCAL documentation. Scope: Modeling Issues targeted at development of OSCAL formats User Story
Projects
None yet
Development

No branches or pull requests

2 participants