Chapter 4.6 follows chapter 4.5, Measurement of the dose, and precedes chapter 4.7, Weaknesses and measured uptake of the treatment, within part 4, the profile library.
4.6.1 Independent-application rule of the documentation profiles
The independent-application rule, the requirement to apply each documentation profile to the build separately from every other profile, keeps one application from changing the starting state for another. The model is built and frozen once. Documentation is then stripped from that build, producing the starting point for profile application. Each profile is applied to that starting point on its own. The resulting variants can therefore be compared by their documentation treatment.
4.6.2 Profile application workflow of the documentation profiles
The workflow for adding a selected documentation profile to a build after documentation has been removed begins with the frozen build, the build held unchanged before documentation removal, and its stripped build, the build after documentation has been removed. An application uses the stripped build as its input, adds the documentation specified by its profile, and produces a variant. The workflow preserves the runnable build while adding the selected documentation. The application also produces a record for traceability. The driver coordinates the profile applications and records their results.
Figure D-L5-1. The six steps that apply one profile to the stripped code and the gate that closes them
%% figure D-L5-1 flowchart LR n1_1["application_order.md"] --> n1_2["prompts/lap-instrumenter.md"] n1_2 --> n1_3["prompts/traceability-builder.md"] n1_3 --> n1_4["gates/lap-quality-reviewer.md"] n2_1["gates/lap_quality_gate.md"] --> n2_2["manifests/lap_instrumentation_manifest_template.json"] n1_4 --> n2_1
source: operations/site-ia/A3-diagram-specification.md
source: operations/site-ia/A6-page-briefs.md, entry L5
Profile application workflow and roles
4.6.3 Instrumentation roles of the documentation profiles
The instrumenter, the role that applies a selected profile to the stripped build, follows the instrumenter prompt and keeps the resulting build functional. The trace-builder, the role that records the application and its outputs, prepares the manifest for that application. These roles keep construction and traceability distinct while connecting each variant to its input and profile.
4.6.4 Quality gate and reviewer role
The quality gate checks the instrumented build against the required build and documentation conditions. It provides a decision point before the variant enters the experiment. The reviewer assesses the documentation produced by the application for accuracy and usefulness. The reviewer accepts a variant that meets the required quality or sends it back for correction.
4.6.5 Application manifest of the documentation profiles
Each application leaves a manifest in the JSON (JavaScript Object Notation) template. The manifest records the applied profile, the source build, the target build, and the changes made. The trace-builder uses this record to connect the resulting variant with its input and application. The quality gate can use the same record when assessing the variant.
4.6.6 Kit file inventory of the documentation profiles
The instrumentation kit is defined by its folder listing. source: 5. Experiment/3. LAP Profile Library/HASP Instrumentation/ (folder listing)
4.6.7 Profile application of the documentation profiles
A profile application starts from the stripped build and uses the instrumenter prompt to produce a variant. The application leaves the manifest that describes the profile, input, output, and changes. Applications remain independent, so one profile application does not supply the starting state for another.
4.6.8 Build driver of the documentation profiles
The driver coordinates profile applications, invokes the application workflow, and records the results. It starts each application from the stripped build and keeps the resulting variants associated with their profiles and manifests.
4.6.9 Build preparation of the documentation profiles
The build is created and frozen before documentation is stripped. The stripped build provides a common starting point for independent applications. A profile application then adds the documentation specified by its profile to produce a corresponding variant.