18F/fedramp-automation

XSpec Clarity - For Scenario FedRAMP OSCAL SSP Attachments - ssp.xspec

markXLIX opened this issue · 0 comments

Extended Description

  • As a user, I would like to read clear XSpec textual representations in the web documentation.

See #516 for more general description.

Note: This issue was not completed due to lack of time nearing end of project.

Acceptance Criteria

  • All Schematron assertion messages are declarative statements which affirm the positive test outcome.
  • All Schematron assertion diagnostic messages are declarative statements which explain the negative test outcome.
  • The Schematron code has no assertion failures when validated using src/validations/styleguides/sch.sch using the basic phase.
  • XSpec unit tests for positive and negative Schematron assertion outcomes accompany all Schematron assertions (where feasible).
  • XSpec descriptions read clearly in the web documentation for the scenario OSCAL FedRAMP SSP

Definition of Done

  • Acceptance criteria met
  • Unit test coverage of our code > 95%
  • Automated code quality checks passed
  • Security reviewed and reported
  • Reviewed against plain language guidelines
  • Code must be self-documenting
  • No local tech debt
  • Load/performance tests passed – needs to be created/automated
  • Documentation updated
  • Architectural Decision Record completed as necessary for significant design choices
  • PR reviewed & approved
  • Source code merged