Documentation Automation [SPIKE]

[brian-ruf]

This is a ...

research - something needs to be investigated

This relates to ...

• the FedRAMP OSCAL baselines
• the FedRAMP SSP OSCAL Example
• the FedRAMP SAP OSCAL Example
• the FedRAMP SAR OSCAL Example
• the FedRAMP POA&M OSCAL Example
• the FedRAMP OSCAL Validations
• the Not sure

User Story

As a maintainer and consumer of FedRAMP OSCAL guidance, documentation, examples, and rules, I want a mechanism that ties the examples, content, and rules together so that documentation can be generated more consistently with reduced manual effort.

This spike/research effort should explore the degree to which metaschema syntax can be used as the basis for keeping documentation consistent.

Goals

• Create a proof-of-concept test that expands the use of the FedRAMP constraints and allowed values meta schema files as a specification and content for documentation.
• If the concept is viable, but changes are needed to the metaschema syntax, define the needed changes.

Dependencies

existing metaschema syntax

Acceptance Criteria

• All FedRAMP Documents Related to OSCAL Adoption (https://github.com/GSA/fedramp-automation) affected by the changes in this issue have been updated.
• A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.

Other information

No response