Skip to content

docs(faq): tighten the OSCAL comparison - #23

Open
jpower432 wants to merge 1 commit into
gemaraproj:mainfrom
jpower432:docs/faq-oscal-accuracy
Open

jpower432 wants to merge 1 commit into
gemaraproj:mainfrom
jpower432:docs/faq-oscal-accuracy

Conversation

@jpower432

Copy link
Copy Markdown
Contributor

This PR refines the OSCAL section of the FAQ by stating which artifacts the SDK converts to OSCAL today and link the tracking issue for the rest. Replace "self-contained" with what it meant: OSCAL documents carry derived values alongside authored intent.

State which artifacts the SDK converts to OSCAL today and link the
tracking issue for the rest. Replace "self-contained" with what it
meant: OSCAL documents carry derived values alongside authored intent.
Add a comparison row on where each format is adapted, content or
structure.

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>
Assisted-by: Claude (model: claude-opus-5-5)

@jmeridth jmeridth left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 (summary) Approving. Nice tightening of the OSCAL claims. One non-blocking note: the SDK also converts Evaluation Logs, and the go-gemara#29 body is out of date in the same way.

Comment thread faq/index.md
### How do I get from Gemara to OSCAL?

The SDK maps Gemara artifacts to their OSCAL equivalents and handles OSCAL-specific requirements like UUID generation. Your source YAML stays lean; the SDK produces the OSCAL output.
The SDK converts Control Catalogs and Guidance Catalogs to their OSCAL equivalents and handles OSCAL-specific requirements like UUID generation. Your source YAML stays lean; the SDK produces the OSCAL output.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 (low, non-blocking) The SDK also converts Evaluation Logs to OSCAL Assessment Results (EvaluationLog(log).ToOSCALAssessmentResults(), shipped in v0.11.0), so this undersells it a bit. The go-gemara#29 body only lists the two catalogs, which might be where this came from. Worth adding?

Suggested change
The SDK converts Control Catalogs and Guidance Catalogs to their OSCAL equivalents and handles OSCAL-specific requirements like UUID generation. Your source YAML stays lean; the SDK produces the OSCAL output.
The SDK converts Control Catalogs and Guidance Catalogs to their OSCAL equivalents, and Evaluation Logs to OSCAL Assessment Results. It handles OSCAL-specific requirements like UUID generation. Your source YAML stays lean; the SDK produces the OSCAL output.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants