Docops/capture requirements with traceability/120 #127
Conversation
ignore: - node_modules/ - _build - dist/ - gh-pages*
| id: 2 | ||
| name: Matching Protocols | ||
| actor: Clinician | ||
| behavior: {activity-that-manages-matching-protocols} |
There was a problem hiding this comment.
@mmroden what should we put here as far as what the tetra does to maintain matching protocols per patient volume?
There was a problem hiding this comment.
Right now, that doing so is part of the testing protocol (ie, that the entire configuration will stay at the PIP/PEEP it's set at when left for several hours).
There was a problem hiding this comment.
is it possible to encapsulate the testing protocol into a sentence here?
| "version": "0.1.0", | ||
| "description": "Project Tetra", | ||
| "repository": "https://github.com/tetrabiodistributed/tetra.git", | ||
| "license": "MIT", |
There was a problem hiding this comment.
Wait, are we MIT or CERN?
There was a problem hiding this comment.
Documentation is MIT. STL files are CERN
| Content in `architecture/` should be consistent with the https://github.com/Mach30/m30ml[Mach30 modeling language (m30ml)]. | ||
| YAML files specified in m30ml should subside in the `0-References/`, `1-StakeholderNeeds`, `2-UserStories`, or `3-Datastructures` directory, | ||
| and be prependend with a number, followed by a dash, the content name in https://wiki.c2.com/?PascalCase[Pascal Case], and a `.yaml`, | ||
| e.g., `2-CubeSatDesignSpecificationRev13.yaml`. |
There was a problem hiding this comment.
is this comment copied from somewhere else?
There was a problem hiding this comment.
Sorry. This was a context-specific example from another project. I'll replace it with something relevant to tetra
| image:https://img.shields.io/badge/Download%20-PDF-blue[Download PDF, link=../dist/{doc-name}.pdf] | ||
| endif::[] | ||
|
|
||
| <<< |
There was a problem hiding this comment.
This '<<<' is showing up as a weird highlight in git, everything's gonna be OK with this, right?
There was a problem hiding this comment.
I'll have to poke as to why it's red, but this is just asciidoc syntax for a page break
https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#breaks
|
When I check the build output, I see "As a Clinician I want to [object Object] so that I can maintain matching protocols per patient volume", that's worded weirdly. The clinician would want to have confidence that the patient PIP and PEEP will not change over time without adjustment by someone involved in the patient's clinical care, and such adjustments will likely need to be noted on the patient's chart. |
What is the activity that the clinician is performing to ensure consistent PEEP or PIP? |
"such adjustments will likely need to be noted on the patient's chart." We will have to require that someone check the PIP and PEEP readings will be noted somewhere, likely the chart, and we will have to verify in our own testing that those settings that appear on the screeen are independently verified. |
WIP preview available on https://capsulecorplab.github.io/tetra/references/stakeholder-concerns-and-requirements/
Document artifacts (i.e., html page & pdf document) are auto-generated from data in the
architecture/folder, whose presentation is defined by a liquid template intemplates/tetra-requirements.adoc.liquid. Contents in the architecture are specified as per the Mach30 modeling languagecloses #120