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

SSP Tutorials - Planning #654

Closed
iMichaela opened this issue Apr 21, 2020 · 5 comments
Closed

SSP Tutorials - Planning #654

iMichaela opened this issue Apr 21, 2020 · 5 comments

Comments

@iMichaela
Copy link
Contributor

User Story:

As an OSCAL tutorial developer, I need to identify which features are most important to be explained in a tutorial, and in how many tutorials should the SSP explanation be split to make each tutorial simple enough to understand the issues, but comprehensive enough to be useful.

Goals:

A list of the tutorials necessary to explain the SSP model and how to create a system's OSCAL SSP and the features that need to be highlighted in each SSP tutorial.

Dependencies:

None

Acceptance Criteria

The list of tutorials and features is clear and complete.

@david-waltermire
Copy link
Contributor

We need to create a strawman outline illustrating the quantity of tutorials and which SSP model features will be covered in each tutorial..

@iMichaela
Copy link
Contributor Author

iMichaela commented Apr 30, 2020

Below is an outline of a set of mini-tutorials:

Tutorial 1

  • Importing the Profile (baseline)
  • System Characteristics
    • System IDs
    • System Description
    • System Information, Impact Level
    • Authorization Boundary
    • Network Architecture and Data Flow

Tutorial 2

  • Expressing the Roles, Parties, Responsibilities
  • Responsible parties

Tutorial 3

Tutorial 4

Tutorial 5

  • Interconnections
  • Leveraged Authorizations

@david-waltermire
Copy link
Contributor

@Rene2mt We should discuss the way forward on this issue which outlines a few tutorials. Once we have a solid outline, I'd like to have you start working on a tutorial in this series.

@david-waltermire david-waltermire moved this from To do to In progress in Sprint 41 May 13, 2021
@david-waltermire david-waltermire added this to To do in Sprint 42 via automation May 13, 2021
@david-waltermire david-waltermire moved this from To do to In progress in Sprint 42 May 13, 2021
@Rene2mt
Copy link
Contributor

Rene2mt commented May 25, 2021

SSP Tutorials Plan (Issue #654)

SSPs have a lot of content. We'll want to develop a series of tutorials that incrementally walks readers through the process of developing an SSP in OSCAL without overwhelming them. The following is a proposed series of SSP related tutorials (e.g., try to follow the Model Overview & Key Concepts.

Metadata Tutorial - Metadata syntax is identical and required in all OSCAL models. It includes information such as the document's title, publication version, publication date, and OSCAL version. Metadata is also used to define roles, parties (people, teams and organizations), and locations.

Tutorial 1: System Characteristics: Represents attributes of the system, such as its name, description, models, and information processed. A lot to cover here so maybe split into several smaller chunks

Tutorial 2: System Implementation: Represents relevant information about the system's deployment, including user roles, interconnections, services, and system inventory.

Tutorial 3: Control Implementation: Describes how profiles are imported and how each control in the baseline is implemented within the system (see issues #819 & #981).

  • Import baseline profile
  • description, set-parameter, implemented-requirement
    • would this be the place to also show how component definitions are used in the SSP?

Back Matter Tutorial: Back matter syntax is identical in all OSCAL models. It is used for resources including attachments, citations, and embedded content such as graphics.

  • NOTE: since back-matter is generic and its syntax is identical for all OSCAL models, it will be covered separately in its own tutorial (not part of the SSP tutorial series)

Overall, the SSP tutorial series would total of 7 relatively small tutorials.

@david-waltermire david-waltermire added this to To do in Sprint 43 via automation Jun 10, 2021
@david-waltermire david-waltermire moved this from In progress to Review in progress in Sprint 42 Jun 10, 2021
@david-waltermire david-waltermire moved this from To do to Review in progress in Sprint 43 Jun 10, 2021
@david-waltermire
Copy link
Contributor

@Rene2mt Thanks for creating the new issues for this. Since these issues will be used for the tutorial development, I am going to close this issue.

Sprint 43 automation moved this from Review in progress to Done Jul 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Sprint 41
In progress
Sprint 42
Review in progress
Development

No branches or pull requests

3 participants