Initial commit

documents/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

documents/_data/systems.yaml

@@ -0,0 +1,10 @@
+---
+rmdc-systems:
+  - name: NukeVault
+    description: Specialized commercial records management system
+    use-cases: Storing Documents and Records generated during design of Project X
+    location: https://nukevault.opennucleonics.org
+  - name: Supplier Portal
+    description: A place where our suppliers can get documents
+    use-cases: External suppliers send documents/records to us
+    location: Online

documents/_static/css/custom.css

@@ -0,0 +1,14 @@
+/* 
+Add brand colors here 
+
+See also: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/styling.html#color-variables
+*/
+html[data-theme="light"] {
+    --pst-color-primary: rgb(126, 3, 3);
+    --pst-color-secondary: rgb(218, 2, 2);
+}
+
+html[data-theme="dark"] {
+    --pst-color-primary: rgb(115, 199, 164);
+    --pst-color-secondary: rgb(21, 197, 124);
+}

documents/bibliography.rst

@@ -0,0 +1,7 @@
+.. only:: html
+
+    ############
+    Bibliography
+    ############
+
+.. bibliography::

documents/conf.py

@@ -0,0 +1,136 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+import datetime
+
+# -- Project information -----------------------------------------------------
+company_name = "Open Nucleonics"
+project = f"{company_name} Governing Documents"
+author = company_name
+release = "1.0"
+version = release
+project_copyright = f"{datetime.datetime.now(tz=datetime.timezone.utc).year}"
+description = f"Procedures, Forms, Templates that govern work at {company_name}"
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinxcontrib.plantuml",
+    "sphinx_needs",
+    "myst_parser",
+    "sphinxcontrib.bibtex",
+    "sphinxcontrib.glossaryused",
+    "sphinx.ext.imgmath",
+    "sphinxcontrib.datatemplates",
+    "sphinxcontrib.mermaid",
+    "sphinx.ext.graphviz",
+    # "sphinx.ext.imgconverter", # SVG to png but rasterizes and bad
+    "sphinxcontrib.inkscapeconverter",  # SVG to pdf without rasterizing
+    "sphinx_timeline",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_book_theme"
+html_title = f"{project} {release}"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+html_logo = "_static/logo.png"
+html_favicon = "_static/favicon.ico"
+html_theme_options = {
+    "logo": {
+        "text": html_title,
+        # "image_light": "_static/logo-light.png",
+        # "image_dark": "_static/logo-dark.png",
+    }
+}
+html_css_files = [
+    "css/custom.css",
+]
+
+# system-specific plantuml config
+# https://sphinx-needs.readthedocs.io/en/latest/installation.html#plantuml-support
+plantuml = "java -Djava.awt.headless=true -jar /usr/share/plantuml/plantuml.jar"
+
+# LaTeX document generation options
+# doesn't work with sphinx-needs
+latex_documents = [
+    (
+        "index",
+        "nrsk.tex",
+        "Nuclear Reactor Starter Kit",
+        author,
+        "manual",
+        False,
+    ),
+]
+#    (
+#        "org/qapd",
+#        "qapd.tex",
+#        "Quality Assurance Program Description",
+#        author,
+#        "howto",
+#        False,
+#    ),
+#    (
+#        "proc/calc",
+#        "proc_calc.tex",
+#        "Engineering Calculation Procedure",
+#        author,
+#        "howto",
+#        False,
+#    ),
+#    (
+#        "proc/software",
+#        "proc_software.tex",
+#        "Software Management Procedure",
+#        author,
+#        "howto",
+#        False,
+#    ),
+# ]
+rst_prolog = f"""
+.. |inst| replace:: **{company_name}**
+"""
+
+# will need to move relevant refs somewhere
+# more reusable, like into the repo?
+bibtex_bibfiles = ["/pool/Reading/refs.bib"]
+
+mermaid_cmd = "./node_modules/.bin/mmdc"
+# enable pdf cropping of mermaid diagrams for fit
+mermaid_pdfcrop = "/usr/bin/pdfcrop"
+mermaid_version = "10.6.1"
+
+# Sphinx Needs config
+needs_include_needs = True  # turn off to hide all needs (e.g. for working docs)

documents/glossary.rst

@@ -0,0 +1,27 @@
+.. need to design a way to bring in multiple glossary data sources
+    so that we can use the global shared glossary + our project
+    specific glossary
+
+#########
+Glossary 
+#########
+
+Glossary
+
+.. glossary::
+
+    Document
+        A written collection of information, instructions, drawings,
+        specifications, etc. that is *maintained* throughout the
+        design/operation/decommissioning of the facility.  Differs from a
+        *record* in that it is expected to be *maintained* by revisions as
+        needed. See :need:`R_APPB_45`
+
+    Record
+        A written collection of information providing evidence of
+        work that was done at a specific time. Records are expected
+        to be *retained* for a certain retention period, e.g. 
+        for the lifetime of the plant or for a given number of years. 
+        See :need:`R_APPB_79`
+    
+    

documents/index.rst

@@ -0,0 +1,22 @@
+|inst| Governing Documents
+===============================
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :caption: Contents:
+
+   purpose/index
+   organization/index
+   procedures/index
+   bibliography
+   requirements/index
+   glossary
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`

documents/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

documents/organization/index.rst

@@ -0,0 +1,8 @@
+############
+Organization
+############
+
+.. toctree::
+
+    organization
+    qapd

documents/organization/org_chart.dot

@@ -0,0 +1,56 @@
+  digraph G {
+    compound=true
+    graph [splines=ortho, nodesep=0.2]
+
+    subgraph clusterBoard{
+      chairman [label="Chairman"];
+      board1
+      board2
+      board3
+    }
+
+    subgraph clusterTop {
+      vision [label="Vision"]
+      values [label="Values"]
+      objectives  [label="Objectives"]
+    }
+
+    chairman -> values [ltail=clusterBoard,lhead=clusterTop]
+
+    subgraph clusterCsuite{
+      CEO [label="Chief\nExecutive\nOfficer"]
+      COO [label="Chief\nOperations\nOfficer"]
+      CTO [label="Chief\nTechnology\nOfficer"]
+      CFO [label="Chief\nFinancial\nOfficer"]
+      CIO [label="Chief\nInformation\nOfficer"]
+      CCO [label="Chief\nCompliance\nOfficer"]
+
+      CEO -> {CFO, CTO, CIO, COO, CCO}
+    }
+    Finance [shape=box];
+    Engineering [shape=box];
+    RD [label="Research &\nDevelopment",shape=box];
+    Operations [shape=box];
+    PM [label="Project\nManagement",shape=box];
+    HR [label="Human\nResources",shape=box];
+    Licensing [shape=box];
+
+    CFO -> Finance;
+    CTO -> {Engineering,RD};
+    CIO -> PM;
+    COO -> {Operations,HR};
+    CCO -> {Licensing};
+
+    values -> CEO [ltail=clusterTop,lhead=clusterCsuite]
+
+    subgraph clusterIT{
+      infra [label="Infrastructure"]
+      help [label="Helpdesk"]
+      hpc [label="High Performance\nComputing"]
+      dev [label="Software\nDevelopment"]
+      label="IT"
+    }
+
+    CIO -> hpc [ltail=clusterTop,lhead=clusterIT]
+
+  } 

documents/organization/organization.rst

@@ -0,0 +1,16 @@
+**********************
+Organization Structure
+**********************
+
+.. _org-chart:
+
+Organization Chart
+==================
+
+Org chart should show:
+
+* Job Titles
+* Departments
+* Authorities
+
+.. graphviz:: org_chart.dot

documents/organization/qapd.rst

@@ -0,0 +1,21 @@
+*************************************
+Quality Assurance Program Description
+*************************************
+
+Basis
+-----
+This document is implemented to satisfy the linked requirements shown below.
+
+.. impl:: Issue a Quality Assurance Program Description
+    :id: I_QAPD
+    :links: R_APPB_1,R_APPB_3,R_APPB_4,R_APPB_5,R_APPB_6
+    :duration: 25
+    :completion: 0
+    :collapse: true
+
+.. needflow:: Basis for this document
+    :filter: "I_QAPD" in links
+
+We are going to do a lot of high quality work in our program, I swear!
+
+.. note:: See NEI 11-04 and 06-14A for generic QAPD templates!

documents/procedures/administration/corrective_action.rst

@@ -0,0 +1,60 @@
+Corrective Action Procedure
+---------------------------
+
+.. impl:: Maintain a Corrective Action Procedure
+    :links: R_APPB_76
+
+    Since Corrective Actions are directly mentioned in AppB, it's wise
+    to have a very clear and direct procedure defining how it will
+    be done.
+
+Measures shall be established to assure that conditions adverse to quality, such
+as failures, malfunctions, deficiencies, deviations, defective material and
+equipment, and nonconformances are promptly identified and corrected.
+
+Corrective Actions are designed to assure that conditions adverse to quality
+are promptly identified and corrected. Such conditions may include:
+
+* Failures
+* Malfunctions
+* Deficiencies
+* Deviations
+* Defective material
+* Defective equipment
+* Nonconformances
+
+.. graphviz:: 
+
+    digraph G {
+        Anyone [label="Anyone",color=green,shape=circle]
+        Identify [label="Identify condition \nadverse to quality",shape=box];
+        Create [label="Create CAQ ticket",shape=box];
+        Notify;
+        Classify [label="Classify significance"];
+        Significant [label="Significant condition\n adverse to quality?",shape=diamond]
+        Cause [label="Determine the cause"];
+        Preclude [label="Do Corrective Actions \nto preclude repetition"];
+        Stop [label="Close ticket\n and stop",color=red,shape=circle];
+
+        Document [shape=house];
+        DCause [label="Document cause \nof condition",shape=note];
+        Action [label="Document actions\ntaken",shape=note];
+        Report [label="Report to \nappropriate management"];
+
+        Anyone -> Identify -> Create -> Notify -> Classify -> Significant;
+
+        Significant -> Cause [label="Yes"];
+        Cause -> Preclude -> Document;
+        Document -> {DCause, Action} -> Report -> Stop;
+        Significant -> Stop [label="No"];
+
+    }  
+
+
+In the case of significant conditions adverse to quality, the measures shall
+assure that the cause of the condition is determined and corrective action taken
+to preclude repetition.  
+
+The identification of the significant condition adverse to quality, the cause of
+the condition, and the corrective action taken shall be documented and reported
+to appropriate levels of management.

documents/procedures/administration/doc-types.yaml

@@ -0,0 +1,16 @@
+- name: Calculation
+  abbrev: CALC
+  use-cases: Documenting an analysis
+  record: False
+  retention: Varies
+- name: Procedure
+  abbrev: PROC
+  use-cases: Defining and dictating how work is done
+  record: False
+  retention: Lifetime
+- name: Form
+  abbrev: FORM
+  use-cases: Providing evidence of tasks that were done
+  record: True
+  retention: Lifetime
+

documents/procedures/administration/document_management.rst

@@ -0,0 +1,98 @@
+Records and Document Management Procedure
+-----------------------------------------
+
+This procedure governs the creation, maintenance, and retention of
+:term:`Records <Record>` and :term:`Documents <Document>`. 
+
+.. impl:: Define processes for lifetime records
+    :links: R_GDC_1_4
+
+.. impl:: Define processes for Document Control
+    :links: R_APPB_45
+
+.. impl:: Define processes for Quality Records
+    :links: R_APPB_79
+
+
+.. _rmdc-systems:
+
+Systems
+^^^^^^^
+
+Documents and records are managed in the following systems.
+
+.. datatemplate:yaml:: 
+    :source: /_data/systems.yaml
+
+    {{ make_list_table_from_mappings(
+        [('Name', 'name'), ('Use case(s)', 'use-cases'), ('Location', 'location')],
+        data['rmdc-systems'],
+        title='RMDC Systems',
+        ) }}
+
+.. _rmdc-origination: 
+
+Origination
+^^^^^^^^^^^
+New records and new or revised documents are originated as invoked by other procedures
+and processes. The following steps shall be taken at such times:
+
+* **Originator** shall specify key data defining the new record/document, including:
+    * Required:
+        * Title --- a single-line description of what the record/document is
+        * Record/document type --- This determines template, review, and
+          retention rules. Should be from :ref:`rmdc-doctypes`
+        * Originating organization --- the organization or group assigned primary authorship. 
+          Internally-generated records/documents shall be contained on the :ref:`org-chart`, while
+          others should be the name and department of external entities.
+    * Optional
+        * Keywords --- words or phrases to assist in future searches/lookups
+
+
+.. impl:: Require document index to be updated upon origination
+    of any new document or record
+    :links: R_APPB_83
+
+    Updating the index at the point of creation is a robust
+    way to ensure compliance that each document/record will always
+    be discoverable and retrievable.
+
+.. _rmdc-doctypes: 
+
+Record/Document Types
+^^^^^^^^^^^^^^^^^^^^^
+One of the following record/document types should be assigned to each
+record/document.  The types are generally associated with specific forms or
+templates that include the expected content/sections, and are often created to
+satisfy the needs of a lower-level procedure.
+
+.. impl:: Define numerous Record/Document types
+
+    There is a timeless debate about having too many vs. too few doc types.
+    Additional types are added to support more mature procedure sets, but then
+    people start to struggle to know what type they should use, leading to
+    cleanup efforts, followed by management declarations to reduce the number of
+    types.
+
+    A good solution to this problem is to be very explicit in your procedural 
+    culture. Ensure that whenever a record or document is being originated, that
+    each staff member has the relevant procedure open and is following it
+    precisely.  Ensure that the procedures are rigorous and precise about which
+    record/document types should be generated in each scenario. When a procedure
+    is written, ensure that any new record/document types are added to the list
+    of known types.
+
+    .. warning:: Don't make one rec/doc type for each individual checklist or form
+        in each procedure though. Those can all be forms. Or maybe do make them 
+        all form subtypes? Could be nice to really have specific evidence.
+        Need easy way to make auto-generated forms per procedure then.
+
+.. datatemplate:yaml:: 
+    :source: doc-types.yaml
+
+    {{ make_list_table_from_mappings(
+        [('Type', 'name'), ('Abbrev', 'abbrev'), ('Use case(s)', 'use-cases'), 
+        ('Record', 'record'), ('Retention', 'retention')],
+        data,
+        title='Record/Document types',
+        ) }}

documents/procedures/administration/index.rst

@@ -0,0 +1,10 @@
+Administration
+##############
+
+Administration procedures govern the management of records, corrective actions,
+and the management of procedures themselves.
+
+.. toctree::
+    :glob:
+
+    * 

documents/procedures/administration/procedure_writing.rst

@@ -0,0 +1,35 @@
+Procedure Management Procedure
+------------------------------
+
+.. impl:: Write and maintain written procedures describing how work is done
+    :links: R_APPB_22
+
+This procedure governs how procedures are created and maintained.
+
+.. impl:: Require that each procedure include acceptance criteria
+    :links: R_APPB_44
+
+Each procedure shall include appropriate quantitative or qualitative
+acceptance criteria for determining that important activities have been
+satisfactorily accomplished.
+
+.. impl:: Keep forms/records/document types synchronized with
+        the Document management plan
+    :links: R_APPB_45, R_APPB_43
+
+    If procedures are precise about what record/document types to use,
+    people will be more likely to put in the appropriate and expected
+    information, maintaining document control.
+
+Whenever a record or document is dictated by a procedure, the procedure shall
+clearly specify with record/document type from the list in :ref:`rmdc-doctypes`
+is to be used.  If a new record or document type is needed for the procedure,
+ensure it is defined and added to the list in :ref:`rmdc-doctypes`.
+
+Procedure review checklist
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+A new or revised procedure should be checked to have the following characteristics:
+
+* It includes acceptance criteria
+* Record/documents generated throughout the procedure are identified
+  clearly, including with type

documents/procedures/administration/writers_guide.rst

@@ -0,0 +1,6 @@
+Writer's Guide
+--------------
+
+See :ref:`meyerProcedureWriterGuide1993`
+
+See :ref:`wieringaProcedureWritingDomains1991`.

documents/procedures/engineering/calc.rst

@@ -0,0 +1,87 @@
+Engineering Calculation Procedure
+*********************************
+
+.. list-table:: Revisions
+   :widths: 20 80
+   :header-rows: 1
+
+   * - Version
+     - Change summary
+   * - 0.1.0
+     - Initial release
+
+Purpose
+=======
+
+Scope
+=====
+
+Definitions
+===========
+
+Roles & Responsibilities
+========================
+
+Originator
+----------
+
+Verifier or Checker
+-------------------
+
+Responsible Manager
+-------------------
+
+Design Authority
+----------------
+
+Safety Basis Authority
+----------------------
+
+Procedure
+=========
+
+General
+-------
+
+Determination of Calculation Type
+---------------------------------
+
+Use of Engineering Calculation Software
+---------------------------------------
+
+Software Management and Quality Assurance
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Functional Classification of Software
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Error Control
+^^^^^^^^^^^^^
+
+Calculations by Others
+----------------------
+
+Registered Professional Engineer
+--------------------------------
+
+Release to Outside Agencies
+---------------------------
+
+References
+==========
+
+Records
+=======
+
+Forms
+-----
+
+
+
+
+Procedure Basis
+===============
+
+The sections in this procedure were informed by Savannah River Conduct of
+Engineering Manual E7 Procedure: 2.31 rev 15
+https://www.nrc.gov/docs/ML2020/ML20206L028.pdf

documents/procedures/engineering/index.rst

@@ -0,0 +1,13 @@
+***********
+Engineering
+***********
+
+Engineering Procedures govern how engineering work is conducted.
+
+.. toctree::
+    :glob:
+    :maxdepth: 1
+
+    calc
+    software
+    * 

documents/procedures/engineering/software.rst

@@ -0,0 +1,81 @@
+Software Management Procedure
+*****************************
+
+.. for revisions, put the full system revision in, so that the entire
+   QA/documentation package is always at the same global revision.
+   For instance if a doc is introduced at rev 2.1.2, then that should
+   be listed as the version of initial release. And then if it's changed
+   next at 2.4.22, that will be the next entry
+
+.. list-table:: Revisions
+   :widths: 20 80
+   :header-rows: 1
+
+   * - Version
+     - Change summary
+   * - 0.1.0
+     - Initial release
+
+
+Purpose
+=======
+
+Scope
+=====
+
+Definitions
+===========
+
+Roles & Responsibilities
+========================
+
+Design Authority
+----------------
+
+Design Agency
+-------------
+
+Design Agency Manager
+---------------------
+
+Quality Reviewers
+-----------------
+
+Independent Reviewers
+---------------------
+
+
+Requirements
+============
+
+General
+-------
+
+References
+==========
+
+Records
+=======
+
+Forms
+-----
+.. Hmm problem: when rendering individual PDFs of each proc the linked requirements
+    are not available. So they'd show up in the HTML version, or a master PDF of all
+    docs, but not in individual procs. Maybe that's a bug not a feature, and we can
+    suppress in all pdfs with .. only html or whatever? Oof but then even the footnotes
+    wouldn't have a target in the PDFs.... this needs more thinking
+
+This section explains how this procedure meets the linked
+regulatory commitments and links to specific requirements.
+
+.. note:: This can help explain why the procedure is designed
+    the way it is to aid in future improvements.
+
+
+.. [sn1] Document things
+
+    .. impl:: Think software here
+        :links: R_APPB_39
+
+        Hi there.
+

documents/procedures/human_resources/index.rst

@@ -0,0 +1,11 @@
+***************
+Human Resources
+***************
+
+
+HR govern how recruiting, hiring, training, qualifications are managed.
+
+.. toctree::
+    :glob:
+
+    *

documents/procedures/index.rst

@@ -0,0 +1,19 @@
+##########
+Procedures
+##########
+
+This section contains Procedures that govern how work gets done at |inst|.
+Compliance with all procedures is required at all times. They are designed to
+ensure consistent and traceable compliance with our regulatory requirements and
+business needs.
+
+.. toctree::
+    :glob:
+    :maxdepth: 2
+
+    administration/index
+    human_resources/index
+    engineering/index
+    operations/index
+    procurement/index
+    *

documents/procedures/operations/index.rst

@@ -0,0 +1,10 @@
+**********
+Operations
+**********
+
+Operations procedures govern how facilities and equipment are operated.
+
+.. toctree::
+    :glob:
+
+    *

documents/procedures/procurement/index.rst

@@ -0,0 +1,11 @@
+***********
+Procurement
+***********
+
+Procurement procedures govern how service and equipment are purchased from
+suppliers and vendors.
+
+.. toctree::
+    :glob:
+
+    *

documents/project/index.rst

@@ -0,0 +1,4 @@
+.. thinking of putting like, all the calcs you have to do during design, 
+    calibrations during commissioning, 
+    work during operations. This would be where we could be like, "Hey don't forget
+    to include impurities in shielding calculations"

documents/purpose/index.rst

@@ -0,0 +1,17 @@
+#######
+Purpose
+#######
+
+This section describes the vision, mission, objectives, and values of this
+institution. These are what differentiate this organization from all others.
+They guide essential decisions every day about what to do, who to hire, how to
+solve problems. They also provide the basis for top-level requirements 
+that drive all underlying work.
+
+
+.. toctree::
+
+    vision
+    values
+    story
+    objectives

documents/purpose/milestones.yml

@@ -0,0 +1,12 @@
+- start: 1885-09-05 
+  name: Hill Valley clock dedicated
+- start: 1955-11-05 
+  name: Had initial innovation
+- start: 1955-11-12 
+  name: Fish Under the Sea ball
+- start: 1985-10-26 01:21 (US/Pacific)
+  name: "Temporal Experiment #1"
+- start: 1985-10-26 01:35 (US/Pacific)
+  name: Accidental time jump
+- start: 2015-10-21 16:29 (US/Pacific)
+  name: Saved Marty Jr.

documents/purpose/objectives.rst

@@ -0,0 +1,24 @@
+**********
+Objectives
+**********
+
+.. Here's where you'll define specific goals and objectives
+  that can drive your actions.
+
+.. todo:: Maybe rename to "activities?"
+
+
+We are the premier potassium vapor turbine manufacturer
+this side of the Mississippi. We:
+
+* Perform research and development on potassium vapor turbines, including:
+
+  * Computational models 
+  * Conceptual design
+  * Materials research
+  * Prototype testing
+
+* Provide design services for customized potassium vapor turbines
+* Manufacture potassium vapor turbines
+* Test and qualify potassium vapor turbines
+

documents/purpose/story.rst

@@ -0,0 +1,21 @@
+*****
+Story
+*****
+
+.. Write up your history here so everyone can know.
+
+Our story began on November 5, 1955. I remember it vividly. I was standing on
+the edge of my toilet hanging a clock. The porcelain was wet. I slipped, hit my
+head on the edge of the sink, and when I came to I had a revelation. A vision.
+A picture in my head. A picture of this. This is what makes time travel
+possible: the flux capacitor!
+
+Historical Milestones
+=====================
+
+.. timeline::
+  :events: ./milestones.yml
+
+  **{{dtrange(day_name=False, short_date=False)}}**
+
+  *{{e.name}}* 

documents/purpose/values.rst

@@ -0,0 +1,24 @@
+******
+Values
+******
+
+.. Define your values here: the specific traits that define your
+   people and organization. Be careful though: ENRON's values were
+   "Respect, Integrity, Communication and Excellence"
+
+We are driven by a set of values, as follows:
+
+* **Innovation** — We come up with ideas no one else has had, except
+  back in the 1950s.
+* **Dedication** — We believe in our challenges and want to work
+  hard to make them go away
+* **Perseverance** — We do things not because they are easy, but because
+  we thought that they would be easy
+
+
+We also have some lesser biases and preferences:
+
+.. This is where you can put things like, "Well we're funded by Jeff Bezos so
+  we generally prefer Amazon Web Services IT solutions" or whatever
+
+* **Open-source** — We use and support open source software and data projects.

documents/purpose/vision.rst

@@ -0,0 +1,11 @@
+******
+Vision
+******
+
+.. The vision is generally a brief statement describing the long-term world in
+    which your efforts are successful. For example, Microsoft's vision once was: "a
+    microcomputer on every desk and in every home". 
+
+Our organization is driven by a singular vision: 
+
+    **"A nuclear reactor on every desk and in every home"**

documents/requirements/index.rst

@@ -0,0 +1,18 @@
+############
+Requirements
+############
+
+This section contains objectives, rules, regulations, codes, and standards that
+are applicable to the institution. These drive the projects goals and constraints
+and are contained here to maintain a linkage between the procedures and their
+bases.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   :glob:
+
+   stakeholder/index
+   national/index
+   standards/index
+   *

documents/requirements/national/USA/10cfr50.rst

@@ -0,0 +1,48 @@
+10 CFR 50
+=========
+
+.. req:: Abide by 10 CFR 50
+    :id: R_10CFR50
+
+.. :basis: Promulgated by the Nuclear Regulatory Commission pursuant to the
+    Atomic Energy Act of 1954, as amended (68 Stat. 919), and Title II of the
+    Energy Reorganization Act of 1974 (88 Stat. 1242), to provide for the
+    licensing of production and utilization facilities
+
+
+Appendix A
+----------
+
+`10 CFR 50 Appendix A
+<https://www.nrc.gov/reading-rm/doc-collections/cfr/part050/part050-appa.html>`_
+contains the General Design Criteria for nuclear power plants, often considered
+primarily for LWRs. For non-LWRs, you may want to bring in RG 1.232, which
+describes the development of PDCs for non-LWRs.
+
+See `NRC summary of non-LWR Design Criteria <https://www.nrc.gov/reactors/new-reactors/advanced/modernizing/rulemaking-and-guidance/nrc-doe-joint-initiative-non-lwr-design-criteria.html>`_
+and `RG 1.232 <https://www.nrc.gov/docs/ML1732/ML17325A611.pdf>`_.
+
+.. needtable:: Appendix A summary
+    :filter: id.startswith("R_GDC")
+    :columns: id
+
+.. include:: /../generated_assets/10-cfr-50-app-a-list.rst
+
+
+Appendix B
+----------
+.. req:: Abide by 10 CFR 50 App B
+    :id: R_10CFR50_APPB
+    :links: R_10CFR50
+    :collapse: true
+
+    `10 CFR 50 Appendix B
+    <https://www.nrc.gov/reading-rm/doc-collections/cfr/part050/part050-appb.html>`_
+    describes the quality assurance criteria for nuclear plants and fuel
+    reprocessing plants.
+    
+.. :basis: Flowed down
+
+.. needimport:: /../generated_assets/10-cfr-50-app-b.json
+    :collapse: true
+    :tags: ["quality"]

documents/requirements/national/index.rst

@@ -0,0 +1,7 @@
+National Regulations
+====================
+
+.. toctree::
+    :glob:
+
+    USA/*

documents/requirements/standards/index.rst

@@ -0,0 +1,8 @@
+###################
+Consensus Standards
+###################
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+

documents/software/index.rst

@@ -0,0 +1,8 @@
+########
+Software
+########
+
+We run a wide variety of software systems to help facilitate our work.
+
+.. toctree::
+    

documents/software/task_management.rst

@@ -0,0 +1,19 @@
+Task Management
+###############
+
+A wide variety of key information fits into the category
+of task management, ranging from formally tracked to 
+casual TODOs. These include:
+
+* Regulatory commitments that we are legally bound to (really?)
+* Conditions and limitations on topical reports (really?)
+* Requests For additional Information (RFIs)
+* Corrective actions
+* Open items
+* Scheduled tasks
+* Bug reports
+* Feature requests
+* Helpdesk tickets
+* Facilities tickets
+* Decomposed tasks (e.g. on a Kanban board)
+* Action items from meetings