dxcomplete 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/README.md +18 -10
  2. package/dist/init.js +19 -0
  3. package/dist/mcp/docs.d.ts +18 -2
  4. package/dist/mcp/docs.js +201 -13
  5. package/dist/mcp/server.js +761 -47
  6. package/dist/runtime/check.d.ts +1 -1
  7. package/dist/runtime/records.d.ts +95 -4
  8. package/dist/runtime/records.js +640 -11
  9. package/dist/validate.js +2 -0
  10. package/docs/codex-integration.md +45 -18
  11. package/docs/glossary.md +39 -7
  12. package/docs/index.md +2 -1
  13. package/docs/model.md +3 -3
  14. package/docs/operating-guide.md +116 -0
  15. package/docs/taxonomy.md +12 -6
  16. package/docs/workflows.md +5 -3
  17. package/package.json +20 -2
  18. package/scripts/smoke-mcp-http.mjs +460 -6
  19. package/src/init.ts +35 -0
  20. package/src/mcp/docs.ts +234 -14
  21. package/src/mcp/server.ts +1138 -83
  22. package/src/runtime/records.ts +914 -12
  23. package/src/validate.ts +2 -0
  24. package/templates/AGENTS.md +30 -0
  25. package/templates/process/controls.yml +10 -6
  26. package/templates/process/diagrams/01-intake-triage.mmd +5 -5
  27. package/templates/process/diagrams/02-product-definition.mmd +1 -1
  28. package/templates/process/diagrams/06-change-release-control.mmd +5 -7
  29. package/templates/process/diagrams/07-deployment-operations.mmd +2 -2
  30. package/templates/process/diagrams/08-support-incident-management.mmd +5 -4
  31. package/templates/process/diagrams/09-problem-improvement.mmd +4 -3
  32. package/templates/process/diagrams/10-risk-control-management.mmd +6 -4
  33. package/templates/process/diagrams/11-audit-evidence-capture.mmd +1 -1
  34. package/templates/process/taxonomy.yml +91 -17
  35. package/templates/process/workflows.yml +10 -9
  36. package/website/flow.html +1 -0
  37. package/website/glossary.html +37 -8
  38. package/website/index.html +2 -1
  39. package/website/objects.html +68 -11
  40. package/website/operating-guide.html +165 -0
  41. package/website/outcomes.html +1 -0
  42. package/website/phase-build.html +1 -0
  43. package/website/phase-elicit.html +1 -0
  44. package/website/phase-go-live.html +2 -1
  45. package/website/phase-measure.html +1 -0
  46. package/website/phase-operate.html +1 -0
  47. package/website/phase-orient.html +1 -0
  48. package/website/phase-weigh.html +1 -0
  49. package/website/roles.html +1 -0
@@ -23,6 +23,7 @@
23
23
  <a class="nav-link" href="./flow.html">Flow</a>
24
24
  <a class="nav-link" href="./objects.html">Records</a>
25
25
  <a class="nav-link" href="./roles.html">Roles</a>
26
+ <a class="nav-link" href="./operating-guide.html">Operating Guide</a>
26
27
  <a class="nav-link" href="./glossary.html">Glossary</a>
27
28
  </nav>
28
29
  </aside>
@@ -45,10 +46,10 @@
45
46
  <a href="#h">H</a>
46
47
  <a href="#i">I</a>
47
48
  <a href="#j">J</a>
48
- <span aria-disabled="true">K</span>
49
+ <a href="#k">K</a>
49
50
  <a href="#l">L</a>
50
51
  <a href="#m">M</a>
51
- <span aria-disabled="true">N</span>
52
+ <a href="#n">N</a>
52
53
  <a href="#o">O</a>
53
54
  <a href="#p">P</a>
54
55
  <a href="#q">Q</a>
@@ -83,8 +84,10 @@
83
84
  <section id="c" class="glossary-letter">
84
85
  <h2>C</h2>
85
86
  <dl class="glossary-list">
86
- <div><dt>Change <span>Delivery</span></dt><dd>A record for a specific alteration to the running service. It keeps the plan, execution, rollback, notice, veto, emergency, decision, result, and recovery history without controlling the operation.</dd></div>
87
+ <div><dt>Cadence <span>Run and support</span></dt><dd>How often recurring operational work is expected to happen, such as every month or every quarter.</dd></div>
88
+ <div><dt>Change <span>Delivery</span></dt><dd>A record for a specific alteration to the running service. It keeps the change type, plan, execution, rollback, notice, veto, decision, result, recovery history, and optional Git commit references without controlling the operation.</dd></div>
87
89
  <div><dt>Change Plan <span>Delivery</span></dt><dd>The part of a Change record that explains what is changing, why, scope, timing, and notice.</dd></div>
90
+ <div><dt>Change Type <span>Delivery</span></dt><dd>The classification of a Change as standard, normal, or emergency.</dd></div>
88
91
  <div><dt>Checkpoint <span>Risk and decisions</span></dt><dd>A confirmation point that reduces risk. It can be approved, formally accepted as risk by the Owner, or proceeded past with open risk visible.</dd></div>
89
92
  <div><dt>Codex <span>Delivery</span></dt><dd>A coding-capable model that may assist the Engineer. Codex is not a role.</dd></div>
90
93
  <div><dt>Commitment <span>Business context</span></dt><dd>An Owner record that says preparation is sufficient to commit requirements or expectations into Build, with any reservations kept visible.</dd></div>
@@ -113,7 +116,7 @@
113
116
  <h2>E</h2>
114
117
  <dl class="glossary-list">
115
118
  <div><dt>Elicit <span>Business context</span></dt><dd>Turning expectations into requirements, dependencies, unknowns, and risk before estimating the work.</dd></div>
116
- <div><dt>Emergency Change <span>Delivery</span></dt><dd>A change where normal notice is shortened or skipped because both importance and immediacy are recorded.</dd></div>
119
+ <div><dt>Emergency Change <span>Delivery</span></dt><dd>A Change where normal notice or review is shortened because the situation is important and immediate.</dd></div>
117
120
  <div><dt>End User <span>Role</span></dt><dd>The person the service is for; uses the service and provides requests, feedback, corrections, and issue reports.</dd></div>
118
121
  <div><dt>Engineer <span>Role</span></dt><dd>The role that turns committed requirements into tasks and working changes, directly or by driving coding-capable tools.</dd></div>
119
122
  <div><dt>Environment <span>Run and support</span></dt><dd>A named operating context such as local, staging, or production. Components belong to one Environment so each context can be understood separately.</dd></div>
@@ -136,6 +139,7 @@
136
139
  <section id="g" class="glossary-letter">
137
140
  <h2>G</h2>
138
141
  <dl class="glossary-list">
142
+ <div><dt>Git Commit Reference <span>Delivery</span></dt><dd>An optional commit identifier recorded on a Change result or recovery event to show what code state was used for that execution attempt or rollback. DX Complete records the reference as provided and does not validate it.</dd></div>
139
143
  <div><dt>Go Live <span>Delivery</span></dt><dd>Putting a change into use after readiness is confirmed.</dd></div>
140
144
  <div><dt>Greenfield <span>Business context</span></dt><dd>Work that starts from a new idea rather than an existing service.</dd></div>
141
145
  </dl>
@@ -151,7 +155,8 @@
151
155
  <section id="i" class="glossary-letter">
152
156
  <h2>I</h2>
153
157
  <dl class="glossary-list">
154
- <div><dt>Incident <span>Run and support</span></dt><dd>An event that affects, or may affect, the service and needs a response.</dd></div>
158
+ <div><dt>Incident <span>Run and support</span></dt><dd>A specific service-impacting or potentially service-impacting occurrence with response history, current status, and severity derived from ordered entries.</dd></div>
159
+ <div><dt>Incident Entry <span>Run and support</span></dt><dd>One ordered entry in an Incident, such as detected, update, severity, resolved, reopened, or note.</dd></div>
155
160
  <div><dt>Informed By <span>Risk and decisions</span></dt><dd>The relationship from a decision to the record that helped inform it.</dd></div>
156
161
  </dl>
157
162
  </section>
@@ -165,6 +170,13 @@
165
170
  </dl>
166
171
  </section>
167
172
 
173
+ <section id="k" class="glossary-letter">
174
+ <h2>K</h2>
175
+ <dl class="glossary-list">
176
+ <div><dt>Known Error <span>Run and support</span></dt><dd>A Problem state showing an underlying cause is known even if the full improvement is not complete.</dd></div>
177
+ </dl>
178
+ </section>
179
+
168
180
  <section id="l" class="glossary-letter">
169
181
  <h2>L</h2>
170
182
  <dl class="glossary-list">
@@ -176,11 +188,20 @@
176
188
  <section id="m" class="glossary-letter">
177
189
  <h2>M</h2>
178
190
  <dl class="glossary-list">
191
+ <div><dt>Maintenance Schedule <span>Run and support</span></dt><dd>A recurring operational hygiene record with cadence, start date, rationale, and due state derived from linked completed Changes or Tasks.</dd></div>
179
192
  <div><dt>Measure <span>Cost and benefit</span></dt><dd>Compare expected and actual cost or benefit when data is available.</dd></div>
193
+ <div><dt>Measured At <span>Cost and benefit</span></dt><dd>The date or time when a value metric baseline or actual value was measured.</dd></div>
180
194
  <div><dt>Measurement <span>Cost and benefit</span></dt><dd>Comparing expected and actual cost or benefit when data is available.</dd></div>
181
195
  </dl>
182
196
  </section>
183
197
 
198
+ <section id="n" class="glossary-letter">
199
+ <h2>N</h2>
200
+ <dl class="glossary-list">
201
+ <div><dt>Normal Change <span>Delivery</span></dt><dd>The default Change type for an assessed alteration to the running service.</dd></div>
202
+ </dl>
203
+ </section>
204
+
184
205
  <section id="o" class="glossary-letter">
185
206
  <h2>O</h2>
186
207
  <dl class="glossary-list">
@@ -195,7 +216,8 @@
195
216
  <section id="p" class="glossary-letter">
196
217
  <h2>P</h2>
197
218
  <dl class="glossary-list">
198
- <div><dt>Problem <span>Run and support</span></dt><dd>An underlying or repeated issue that may need deeper improvement work.</dd></div>
219
+ <div><dt>Problem <span>Run and support</span></dt><dd>An underlying or recurring cause evidenced by one or more Incidents, with investigation, root-cause, known-error, and resolution history.</dd></div>
220
+ <div><dt>Problem Entry <span>Run and support</span></dt><dd>One ordered entry in a Problem, such as identified, investigation, root cause, known error, resolved, reopened, or note.</dd></div>
199
221
  <div><dt>Proceeding Past an Open Checkpoint <span>Risk and decisions</span></dt><dd>Moving forward while an approval, readiness concern, or other checkpoint is still open. The risk remains visible and is not formally accepted.</dd></div>
200
222
  <div><dt>Product Validation <span>Delivery</span></dt><dd>Confirming that the completed work achieves the intended outcome.</dd></div>
201
223
  </dl>
@@ -221,10 +243,13 @@
221
243
  <div><dt>Requirement Set <span>Business context</span></dt><dd>The group of requirements being estimated, committed, built, or stopped together.</dd></div>
222
244
  <div><dt>Reservation <span>Business context</span></dt><dd>A concern recorded inside a Commitment when the Owner moves forward despite it.</dd></div>
223
245
  <div><dt>Review Note <span>Delivery</span></dt><dd>A free-text note on an expectation or requirement. It may be marked important, but it does not block progress or require an Owner response.</dd></div>
224
- <div><dt>Risk <span>Risk and decisions</span></dt><dd>Something uncertain that could affect value, delivery, service, or compliance.</dd></div>
246
+ <div><dt>Risk <span>Risk and decisions</span></dt><dd>Something uncertain that could affect value, delivery, service, compliance, or operations. Current risk state comes from ordered entries.</dd></div>
225
247
  <div><dt>Risk Acceptance <span>Risk and decisions</span></dt><dd>An Owner decision to own an open risk on the project's behalf. It is different from simply proceeding past an open checkpoint.</dd></div>
248
+ <div><dt>Risk Entry <span>Risk and decisions</span></dt><dd>One ordered entry in a Risk, such as identified, assessment, treatment, monitor note, closed, or reopened.</dd></div>
249
+ <div><dt>Risk Treatment <span>Risk and decisions</span></dt><dd>The chosen response to a Risk: accept, mitigate, transfer, or avoid. Formal acceptance is Owner-only.</dd></div>
226
250
  <div><dt>Roll-up <span>Cost and benefit</span></dt><dd>Grouped totals from quantified cost or benefit items, keeping one-time amounts, recurring amounts, periods, and currencies distinct.</dd></div>
227
251
  <div><dt>Rollback Plan <span>Delivery</span></dt><dd>The part of a Change record that explains how to reverse or recover if the change fails or should not remain in use.</dd></div>
252
+ <div><dt>Root Cause <span>Run and support</span></dt><dd>The underlying cause recorded in a Problem when investigation identifies why one or more incidents occurred.</dd></div>
228
253
  </dl>
229
254
  </section>
230
255
 
@@ -232,10 +257,12 @@
232
257
  <h2>S</h2>
233
258
  <dl class="glossary-list">
234
259
  <div><dt>Secret Pointer <span>Run and support</span></dt><dd>A reference to where a secret is stored and what it is called. It should not contain the secret value.</dd></div>
260
+ <div><dt>Standard Change <span>Delivery</span></dt><dd>A low-risk, pre-understood, repeatable Change type.</dd></div>
235
261
  <div><dt>Statement <span>Business context</span></dt><dd>A person's own words before they are interpreted or translated.</dd></div>
236
262
  <div><dt>Success Criteria <span>Delivery</span></dt><dd>The conditions used to decide whether completed work satisfies the need.</dd></div>
237
263
  <div><dt>Support Agent <span>Role</span></dt><dd>The role that helps users, captures signals, and routes questions, feedback, and issues to the right follow-up.</dd></div>
238
- <div><dt>Support Ticket <span>Run and support</span></dt><dd>A user request, question, or issue report.</dd></div>
264
+ <div><dt>Support Request <span>Run and support</span></dt><dd>A shared support record for a reported user experience, question, request, or issue that needs workspace-visible follow-up.</dd></div>
265
+ <div><dt>Support Request Entry <span>Run and support</span></dt><dd>One ordered entry in a Support Request, such as raised, triage, update, escalated, resolved, reopened, or note.</dd></div>
239
266
  </dl>
240
267
  </section>
241
268
 
@@ -259,6 +286,8 @@
259
286
  <section id="v" class="glossary-letter">
260
287
  <h2>V</h2>
261
288
  <dl class="glossary-list">
289
+ <div><dt>Value Metric <span>Cost and benefit</span></dt><dd>One before-and-after measure inside Value Realization, with a baseline, optional actual value, unit, direction, and measured dates.</dd></div>
290
+ <div><dt>Value Realization <span>Cost and benefit</span></dt><dd>A record that compares baseline and actual value metrics after work or operation when measurement is available.</dd></div>
262
291
  <div><dt>Version History <span>Risk and decisions</span></dt><dd>Prior versions kept when an expectation or requirement changes, so current wording can be understood without losing what came before.</dd></div>
263
292
  <div><dt>Veto <span>Risk and decisions</span></dt><dd>A serious recorded objection to a Change by the Owner or Engineer. It does not mechanically stop the Operator, but proceeding over it creates a strong accountability record.</dd></div>
264
293
  </dl>
@@ -28,6 +28,7 @@
28
28
  <a class="nav-link" href="./flow.html">Flow</a>
29
29
  <a class="nav-link" href="./objects.html">Records</a>
30
30
  <a class="nav-link" href="./roles.html">Roles</a>
31
+ <a class="nav-link" href="./operating-guide.html">Operating Guide</a>
31
32
  <a class="nav-link" href="./glossary.html">Glossary</a>
32
33
  </nav>
33
34
  </aside>
@@ -40,7 +41,7 @@
40
41
  A practical way to decide what is worth doing, deliver it with control, run it safely, and learn from the results.
41
42
  </p>
42
43
  <p>
43
- The documentation is split into outcomes, flow, records, roles, and terms. Outcomes explain why the process exists. Flow explains what happens over time. Records explain what gets captured. Roles explain who is responsible. The glossary defines shared language.
44
+ The documentation is split into outcomes, flow, records, roles, operating guidance, and terms. Outcomes explain why the process exists. Flow explains what happens over time. Records explain what gets captured. Roles explain who is responsible. The Operating Guide explains how each role uses the records. The glossary defines shared language.
44
45
  </p>
45
46
 
46
47
  <div class="phase-map" aria-label="DX Complete broad phases">
@@ -23,6 +23,7 @@
23
23
  <a class="nav-link" href="./flow.html">Flow</a>
24
24
  <a class="nav-link" href="./objects.html">Records</a>
25
25
  <a class="nav-link" href="./roles.html">Roles</a>
26
+ <a class="nav-link" href="./operating-guide.html">Operating Guide</a>
26
27
  <a class="nav-link" href="./glossary.html">Glossary</a>
27
28
  </nav>
28
29
  </aside>
@@ -47,8 +48,13 @@
47
48
  <div><span>Desired result</span><b>Use Statement, Expectation, or Requirement</b><p>Use these when the information says what should be true, what success looks like, or what must be made buildable.</p></div>
48
49
  <div><span>Choice</span><b>Use Decision</b><p>Use Decision when alternatives were considered and a choice should remain visible.</p></div>
49
50
  <div><span>Action</span><b>Use Task</b><p>Use Task when someone needs to do or coordinate work.</p></div>
50
- <div><span>Service event or risk</span><b>Use Change or Risk</b><p>Use the matching record when the information is controlled history, service change, uncertainty, or exposure.</p></div>
51
+ <div><span>Run-side alteration</span><b>Use Change</b><p>Use Change for a discrete alteration to the running service, with plan, execution, rollback, risk, and event history.</p></div>
52
+ <div><span>User support follow-up</span><b>Use Support Request</b><p>Use Support Request for a shared user-facing question, request, or issue that needs follow-up.</p></div>
53
+ <div><span>Uncertainty or exposure</span><b>Use Risk</b><p>Use Risk when something uncertain could affect value, delivery, service, or compliance.</p></div>
51
54
  <div><span>Infrastructure state</span><b>Use Environment or Component</b><p>Use the Operational Registry for what exists, where it lives, and which secret locations matter.</p></div>
55
+ <div><span>Recurring operations</span><b>Use Maintenance Schedule</b><p>Use Maintenance Schedule for recurring service hygiene, such as scheduled checks, reviews, rotations, or maintenance duties.</p></div>
56
+ <div><span>Measured value</span><b>Use Value Realization</b><p>Use Value Realization when actual before-and-after value can be compared.</p></div>
57
+ <div><span>User question or report</span><b>Use DX Complete Ticket</b><p>Use a ticket first when a user raises a question, report, request, correction, or follow-up with DX Complete.</p></div>
52
58
  <div><span>Useful context</span><b>Use Journal</b><p>Use Journal for relevant background, preference, observation, or context that does not fit a dedicated record.</p></div>
53
59
  </div>
54
60
  <p>
@@ -143,6 +149,15 @@
143
149
  <div><span>Version history</span><b>Automatic</b><p>Prior versions are kept when Benefits change.</p></div>
144
150
  </div>
145
151
  </details>
152
+ <details class="record-item">
153
+ <summary><span class="record-name">Value Realization</span><span class="record-summary">Measured before-and-after value for expectations, requirements, or commitments.</span></summary>
154
+ <div class="record-fields" aria-label="Value Realization fields">
155
+ <div><span>Value metrics</span><b>Required</b><p>One or more measures with a baseline, unit, direction, and optional actual value.</p></div>
156
+ <div><span>Covered scope</span><b>Required</b><p>The expectations, requirements, or commitments the measurement relates to.</p></div>
157
+ <div><span>Comparison</span><b>Automatic</b><p>Measured metrics show improvement, regression, no change, or an open measurement gap.</p></div>
158
+ <div><span>Version history</span><b>Automatic</b><p>Prior versions are kept when metrics change.</p></div>
159
+ </div>
160
+ </details>
146
161
  <details class="record-item">
147
162
  <summary><span class="record-name">Commitment</span><span class="record-summary">An Owner record that moves requirements or expectations into Build.</span></summary>
148
163
  <div class="record-fields" aria-label="Commitment fields">
@@ -162,14 +177,14 @@
162
177
  </div>
163
178
  </details>
164
179
  <details class="record-item">
165
- <summary><span class="record-name">Risk</span><span class="record-summary">Something uncertain that could affect value, delivery, service, or compliance.</span></summary>
180
+ <summary><span class="record-name">Risk</span><span class="record-summary">Something uncertain that could affect value, delivery, service, compliance, or operations.</span></summary>
166
181
  <div class="record-fields" aria-label="Risk fields">
167
- <div><span>Risk</span><b>Required</b><p>The uncertainty or exposure.</p></div>
168
- <div><span>Impact</span><b>Required</b><p>What could happen if the risk occurs.</p></div>
169
- <div><span>Likelihood</span><b>Optional</b><p>How likely the risk seems.</p></div>
170
- <div><span>Response</span><b>Optional</b><p>How the risk should be reduced, accepted, avoided, or watched.</p></div>
171
- <div><span>Checkpoint</span><b>Optional</b><p>The open confirmation or check that creates this risk.</p></div>
172
- <div><span>Responsible person</span><b>Optional</b><p>Who is responsible for watching or handling it.</p></div>
182
+ <div><span>Topic</span><b>Required</b><p>The uncertainty or exposure being tracked.</p></div>
183
+ <div><span>Risk entries</span><b>Required</b><p>Identification, assessment, treatment, monitoring, closure, and reopening entries kept in order.</p></div>
184
+ <div><span>Current status</span><b>Automatic</b><p>Whether the risk is open or closed, derived from the latest status entry.</p></div>
185
+ <div><span>Current assessment</span><b>Optional</b><p>The latest likelihood and impact assessment.</p></div>
186
+ <div><span>Current treatment</span><b>Optional</b><p>The latest response: accept, mitigate, transfer, or avoid.</p></div>
187
+ <div><span>Acceptance boundary</span><b>Required</b><p>Formal risk acceptance belongs to the Owner.</p></div>
173
188
  </div>
174
189
  </details>
175
190
  </div>
@@ -193,11 +208,43 @@
193
208
  <details class="record-item">
194
209
  <summary><span class="record-name">Change</span><span class="record-summary">A record for a specific alteration to the running service.</span></summary>
195
210
  <div class="record-fields" aria-label="Change fields">
211
+ <div><span>Change type</span><b>Required</b><p>Whether the change is standard, normal, or emergency.</p></div>
196
212
  <div><span>Change plan</span><b>Required</b><p>What is changing, why, scope, timing, and notice.</p></div>
197
213
  <div><span>Execution plan</span><b>Required</b><p>The ordered steps for carrying out the change.</p></div>
198
214
  <div><span>Rollback plan</span><b>Required</b><p>How to reverse or recover if the change should not remain in use.</p></div>
199
- <div><span>Risk and impact</span><b>Required</b><p>The expected risk, service impact, and open concerns.</p></div>
200
- <div><span>Events</span><b>Optional</b><p>Notice, veto, emergency, decision, result, recovery, notes, and revisions kept in order.</p></div>
215
+ <div><span>Risk and impact</span><b>Required</b><p>The expected risk, service impact, open concerns, and downstream impact: what else may be affected and what depends on what is changing.</p></div>
216
+ <div><span>Events</span><b>Optional</b><p>Notice, veto, decision, result, recovery, notes, and revisions kept in order. Result and recovery events can include optional Git commit references.</p></div>
217
+ <div><span>Boundary</span><b>Required</b><p>Use Change for run-side service alteration, not ordinary build work.</p></div>
218
+ </div>
219
+ </details>
220
+ <details class="record-item">
221
+ <summary><span class="record-name">Incident</span><span class="record-summary">A specific service-impacting or potentially service-impacting occurrence.</span></summary>
222
+ <div class="record-fields" aria-label="Incident fields">
223
+ <div><span>Description</span><b>Required</b><p>What happened or may be happening.</p></div>
224
+ <div><span>Incident entries</span><b>Required</b><p>Detection, updates, severity changes, resolution, reopening, and notes kept in order.</p></div>
225
+ <div><span>Current status</span><b>Automatic</b><p>Whether the Incident is open or resolved, derived from entries.</p></div>
226
+ <div><span>Current severity</span><b>Optional</b><p>The latest recorded severity.</p></div>
227
+ <div><span>Affected Components</span><b>Optional</b><p>The operational items affected by the occurrence.</p></div>
228
+ </div>
229
+ </details>
230
+ <details class="record-item">
231
+ <summary><span class="record-name">Problem</span><span class="record-summary">An underlying or recurring cause evidenced by one or more Incidents.</span></summary>
232
+ <div class="record-fields" aria-label="Problem fields">
233
+ <div><span>Description</span><b>Required</b><p>The cause or pattern being investigated.</p></div>
234
+ <div><span>Related Incidents</span><b>Required</b><p>The Incidents that provide evidence for the Problem.</p></div>
235
+ <div><span>Problem entries</span><b>Required</b><p>Identification, investigation, root cause, known error, resolution, reopening, and notes kept in order.</p></div>
236
+ <div><span>Current status</span><b>Automatic</b><p>The latest Problem state derived from entries.</p></div>
237
+ <div><span>Current root cause</span><b>Optional</b><p>The latest recorded root cause.</p></div>
238
+ </div>
239
+ </details>
240
+ <details class="record-item">
241
+ <summary><span class="record-name">Support Request</span><span class="record-summary">A shared support record for a user-facing question, request, or issue.</span></summary>
242
+ <div class="record-fields" aria-label="Support Request fields">
243
+ <div><span>Reporter</span><b>Required</b><p>The person, role, or channel that reported the experience.</p></div>
244
+ <div><span>Reported experience</span><b>Required</b><p>What the user reported, requested, asked, or experienced.</p></div>
245
+ <div><span>Support entries</span><b>Required</b><p>Raised, triage, update, escalation, resolution, reopening, and notes kept in order.</p></div>
246
+ <div><span>Current status</span><b>Automatic</b><p>The latest support state derived from entries.</p></div>
247
+ <div><span>Escalated Incident</span><b>Optional</b><p>An Incident linked when the support request becomes an operational occurrence.</p></div>
201
248
  </div>
202
249
  </details>
203
250
  </div>
@@ -227,6 +274,16 @@
227
274
  <div><span>Version history</span><b>Automatic</b><p>Prior versions are kept when the Component changes.</p></div>
228
275
  </div>
229
276
  </details>
277
+ <details class="record-item">
278
+ <summary><span class="record-name">Maintenance Schedule</span><span class="record-summary">Recurring operational hygiene with cadence and due state.</span></summary>
279
+ <div class="record-fields" aria-label="Maintenance Schedule fields">
280
+ <div><span>Name and kind</span><b>Required</b><p>What recurring operational duty this schedule represents.</p></div>
281
+ <div><span>Cadence</span><b>Required</b><p>How often the work should happen.</p></div>
282
+ <div><span>Start date</span><b>Required</b><p>The first date used to calculate when the work is due.</p></div>
283
+ <div><span>Due state</span><b>Automatic</b><p>Next due date and overdue state are derived from cadence and linked completed Changes or Tasks.</p></div>
284
+ <div><span>Version history</span><b>Automatic</b><p>Prior versions are kept when the schedule changes.</p></div>
285
+ </div>
286
+ </details>
230
287
  </div>
231
288
  <p>
232
289
  The Operational Registry is inventory only. It does not monitor, diagnose, store secret values, keep event history, or replace operating procedures.
@@ -272,7 +329,7 @@
272
329
  <div><span>Constraints, dependencies, and unknowns</span><b>Concept</b><p>These are normally captured in requirements, risks, decisions, review notes, or task details.</p></div>
273
330
  <div><span>Verification and validation</span><b>Concept</b><p>Checks and outcomes can be captured in task details, change history, decisions, or linked notes.</p></div>
274
331
  <div><span>Release, deployment, controls, and evidence</span><b>Concept</b><p>These are currently represented through Change events, risks, decisions, and supporting notes.</p></div>
275
- <div><span>Support, incidents, problems, and feedback</span><b>Concept</b><p>Operational signals can be handled through tickets, risks, tasks, changes, decisions, or new requirements.</p></div>
332
+ <div><span>Support, incidents, problems, and feedback</span><b>Concept</b><p>Operational signals can be handled through tickets, incidents, problems, risks, tasks, changes, decisions, or new requirements.</p></div>
276
333
  <div><span>Measurement and estimate refinement</span><b>Concept</b><p>Actual cost or benefit observations can update estimates, benefits, risks, decisions, or future work.</p></div>
277
334
  </div>
278
335
  </div>
@@ -0,0 +1,165 @@
1
+ <!doctype html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
6
+ <title>Operating Guide | DX Complete</title>
7
+ <link rel="stylesheet" href="./styles.css?v=5" />
8
+ </head>
9
+ <body>
10
+ <a class="skip-link" href="#content">Skip to content</a>
11
+ <header class="topbar">
12
+ <div class="topbar__brand">
13
+ <span class="brand-mark" aria-hidden="true">DX</span>
14
+ <span><strong>DX Complete</strong><small>Plan, deliver, run, measure</small></span>
15
+ </div>
16
+ </header>
17
+ <div class="layout">
18
+ <aside class="sidebar" aria-label="Documentation pages">
19
+ <div class="sidebar__eyebrow">Pages</div>
20
+ <nav>
21
+ <a class="nav-link" href="./index.html">Start here</a>
22
+ <a class="nav-link" href="./outcomes.html">Outcomes</a>
23
+ <a class="nav-link" href="./flow.html">Flow</a>
24
+ <a class="nav-link" href="./objects.html">Records</a>
25
+ <a class="nav-link" href="./roles.html">Roles</a>
26
+ <a class="nav-link" href="./operating-guide.html">Operating Guide</a>
27
+ <a class="nav-link" href="./glossary.html">Glossary</a>
28
+ </nav>
29
+ </aside>
30
+ <main id="content" class="content" tabindex="-1">
31
+ <section class="doc-section doc-section--last">
32
+ <p class="section-kicker">Operating guide</p>
33
+ <h1>How roles use DX Complete</h1>
34
+ <p class="lede">
35
+ DX Complete is easiest to use when each person knows which records belong to their part of the work.
36
+ </p>
37
+ <p>
38
+ This guide shows the normal record choices by role. It is not meant to make every activity heavier. Use the smallest record that keeps the work understandable.
39
+ </p>
40
+
41
+ <section class="record-groups" aria-label="Role operating guidance">
42
+ <section>
43
+ <span>Owner</span>
44
+ <h2>Direction, value, and authority</h2>
45
+ <p>
46
+ The Owner sets direction, weighs value against cost and risk, records Commitment or Deferral, validates outcomes, and formally accepts risk when the project should own it.
47
+ </p>
48
+ <div class="record-fields" aria-label="Owner record use">
49
+ <div><span>Usually uses</span><b>Records</b><p>Statement, Expectation, Benefits, Value Realization, Commitment, Deferral, Decision, and Risk.</p></div>
50
+ <div><span>Watch for</span><b>Boundary</b><p>Do not turn every comment into a requirement. Do not use approval language for End User feedback.</p></div>
51
+ </div>
52
+ </section>
53
+
54
+ <section>
55
+ <span>Engineer and Codex assistance</span>
56
+ <h2>Build from requirements</h2>
57
+ <p>
58
+ The Engineer turns committed requirements into tasks and working changes. Coding-capable tools such as Codex may assist the Engineer, but they are not separate DX Complete roles.
59
+ </p>
60
+ <div class="record-fields" aria-label="Engineer record use">
61
+ <div><span>Default path</span><b>Task</b><p>Use Requirement to Task for normal build work.</p></div>
62
+ <div><span>When needed</span><b>Decision</b><p>Use Decision for meaningful design choices or tradeoffs.</p></div>
63
+ <div><span>When exposed</span><b>Risk</b><p>Use Risk when uncertainty could affect value, delivery, service, or compliance.</p></div>
64
+ <div><span>When running service changes</span><b>Change</b><p>Use Change only when the work becomes a discrete alteration to the running service.</p></div>
65
+ </div>
66
+ </section>
67
+
68
+ <section>
69
+ <span>Tester</span>
70
+ <h2>Verification evidence</h2>
71
+ <p>
72
+ The Tester checks completed work against requirements and success criteria, then keeps the evidence visible in the record that best matches what was learned.
73
+ </p>
74
+ <div class="record-fields" aria-label="Tester record use">
75
+ <div><span>Normal evidence</span><b>Task</b><p>Use Task entries for verification notes tied to build work.</p></div>
76
+ <div><span>Requirement feedback</span><b>Review note</b><p>Use review notes when the check reveals useful input on a requirement.</p></div>
77
+ <div><span>Uncertainty</span><b>Risk</b><p>Use Risk when a test result exposes uncertainty or possible harm.</p></div>
78
+ <div><span>Boundary</span><b>No default Change</b><p>Do not create a Change record merely because testing is happening.</p></div>
79
+ </div>
80
+ </section>
81
+
82
+ <section>
83
+ <span>Operator and administration</span>
84
+ <h2>Run the service safely</h2>
85
+ <p>
86
+ The Operator manages run-side change, incidents, problems, operational inventory, rollout and rollback planning, monitoring, users, permissions, settings, provisioning, and run-side security.
87
+ </p>
88
+ <div class="record-fields" aria-label="Operator record use">
89
+ <div><span>Service change</span><b>Change</b><p>Use Change for a discrete alteration to the running service, with execution and rollback plans.</p></div>
90
+ <div><span>Service occurrence</span><b>Incident</b><p>Use Incident for a specific service-impacting or potentially service-impacting occurrence.</p></div>
91
+ <div><span>Underlying cause</span><b>Problem</b><p>Use Problem for an underlying or recurring cause evidenced by incidents.</p></div>
92
+ <div><span>Inventory</span><b>Environment</b><p>Use Environment for named operating contexts such as local, staging, or production.</p></div>
93
+ <div><span>Inventory detail</span><b>Component</b><p>Use Component for environment-specific apps, databases, queues, storage, external services, and other operational items.</p></div>
94
+ <div><span>Recurring hygiene</span><b>Maintenance Schedule</b><p>Use Maintenance Schedule for recurring checks, reviews, rotations, or maintenance duties.</p></div>
95
+ <div><span>Boundary</span><b>Secrets</b><p>Record where secrets are stored and what they are called, not the secret values.</p></div>
96
+ </div>
97
+ </section>
98
+
99
+ <section>
100
+ <span>Support Agent</span>
101
+ <h2>Route user signals</h2>
102
+ <p>
103
+ The Support Agent helps users, captures questions and reports, and routes signals into shared follow-up only when a shared record is needed.
104
+ </p>
105
+ <div class="record-fields" aria-label="Support Agent record use">
106
+ <div><span>Shared follow-up</span><b>Support Request</b><p>Use Support Request for a user-facing question, report, request, or issue that needs shared follow-up.</p></div>
107
+ <div><span>Private DX Complete contact</span><b>DX Complete Ticket</b><p>Use DX Complete Ticket for private questions, reports, requests, corrections, or follow-ups with DX Complete itself.</p></div>
108
+ <div><span>Promote when needed</span><b>Records</b><p>Promote to Statement, Requirement, Task, Incident, Problem, Risk, Decision, Change, or Journal only when the signal has that meaning.</p></div>
109
+ <div><span>Boundary</span><b>Restraint</b><p>Do not create process records just because a user said something. Create them when the signal has work, risk, decision, or service-control meaning.</p></div>
110
+ </div>
111
+ </section>
112
+
113
+ <section>
114
+ <span>End User</span>
115
+ <h2>Input, not operation</h2>
116
+ <p>
117
+ The End User uses the service and provides requests, feedback, corrections, and issue reports. Another role captures that input when it belongs in DX Complete.
118
+ </p>
119
+ <div class="record-fields" aria-label="End User record boundary">
120
+ <div><span>Input becomes</span><b>Signal</b><p>Statement, report, request, correction, feedback signal, or ticket.</p></div>
121
+ <div><span>Boundary</span><b>No approval</b><p>End User feedback is not authority approval unless that person is also acting in an authority role.</p></div>
122
+ </div>
123
+ </section>
124
+ </section>
125
+
126
+ <section class="record-groups" aria-label="Record routing">
127
+ <section>
128
+ <span>Routing</span>
129
+ <h2>Choosing the right record</h2>
130
+ <div class="record-fields" aria-label="Record routing by situation">
131
+ <div><span>Normal build work</span><b>Task</b><p>Use Task for concrete work someone needs to do.</p></div>
132
+ <div><span>Meaningful choice</span><b>Decision</b><p>Use Decision when alternatives were considered and the choice should remain legible.</p></div>
133
+ <div><span>Uncertainty or exposure</span><b>Risk</b><p>Use Risk when something uncertain could affect value, delivery, service, or compliance.</p></div>
134
+ <div><span>Run-side alteration</span><b>Change</b><p>Use Change for a discrete alteration to the running service.</p></div>
135
+ <div><span>Service occurrence</span><b>Incident</b><p>Use Incident for a specific service-impacting occurrence that needs response history.</p></div>
136
+ <div><span>Underlying cause</span><b>Problem</b><p>Use Problem when one or more incidents point to a deeper or recurring cause.</p></div>
137
+ <div><span>User support follow-up</span><b>Support Request</b><p>Use Support Request for a shared user-facing support thread.</p></div>
138
+ <div><span>Operational inventory</span><b>Registry</b><p>Use Environment and Component for what exists, where it lives, and which secret locations matter.</p></div>
139
+ <div><span>Recurring operations</span><b>Maintenance Schedule</b><p>Use Maintenance Schedule for recurring service hygiene.</p></div>
140
+ <div><span>Measured value</span><b>Value Realization</b><p>Use Value Realization for before-and-after metrics tied to expectations, requirements, or commitments.</p></div>
141
+ <div><span>Useful context</span><b>Journal</b><p>Use Journal only when the context has no better dedicated record home.</p></div>
142
+ <div><span>Private DX Complete contact</span><b>Ticket</b><p>Use DX Complete Ticket for private communication with DX Complete.</p></div>
143
+ </div>
144
+ <p>
145
+ The simplest test is: will anything reference or depend on this? If yes, use the dedicated record that can carry that relationship.
146
+ </p>
147
+ </section>
148
+
149
+ <section>
150
+ <span>ITSM boundary</span>
151
+ <h2>Use service records only when they fit</h2>
152
+ <p>
153
+ Change is the current first-class run-side control record. Use it for a specific alteration to the running service, with a change type, plan, execution path, rollback path, risk, and event history.
154
+ </p>
155
+ <p>
156
+ Incident is for a specific service-impacting or potentially service-impacting occurrence. Problem is for an underlying or recurring cause evidenced by incidents. Do not create service-control records merely because work is happening; use them when the service-control meaning fits.
157
+ </p>
158
+ </section>
159
+ </section>
160
+ </section>
161
+ </main>
162
+ </div>
163
+ <script src="./app.js?v=5"></script>
164
+ </body>
165
+ </html>
@@ -23,6 +23,7 @@
23
23
  <a class="nav-link" href="./flow.html">Flow</a>
24
24
  <a class="nav-link" href="./objects.html">Records</a>
25
25
  <a class="nav-link" href="./roles.html">Roles</a>
26
+ <a class="nav-link" href="./operating-guide.html">Operating Guide</a>
26
27
  <a class="nav-link" href="./glossary.html">Glossary</a>
27
28
  </nav>
28
29
  </aside>
@@ -23,6 +23,7 @@
23
23
  <a class="nav-link" href="./flow.html">Flow</a>
24
24
  <a class="nav-link" href="./objects.html">Records</a>
25
25
  <a class="nav-link" href="./roles.html">Roles</a>
26
+ <a class="nav-link" href="./operating-guide.html">Operating Guide</a>
26
27
  <a class="nav-link" href="./glossary.html">Glossary</a>
27
28
  </nav>
28
29
  </aside>
@@ -23,6 +23,7 @@
23
23
  <a class="nav-link" href="./flow.html">Flow</a>
24
24
  <a class="nav-link" href="./objects.html">Records</a>
25
25
  <a class="nav-link" href="./roles.html">Roles</a>
26
+ <a class="nav-link" href="./operating-guide.html">Operating Guide</a>
26
27
  <a class="nav-link" href="./glossary.html">Glossary</a>
27
28
  </nav>
28
29
  </aside>
@@ -23,6 +23,7 @@
23
23
  <a class="nav-link" href="./flow.html">Flow</a>
24
24
  <a class="nav-link" href="./objects.html">Records</a>
25
25
  <a class="nav-link" href="./roles.html">Roles</a>
26
+ <a class="nav-link" href="./operating-guide.html">Operating Guide</a>
26
27
  <a class="nav-link" href="./glossary.html">Glossary</a>
27
28
  </nav>
28
29
  </aside>
@@ -80,7 +81,7 @@
80
81
  <ul>
81
82
  <li>Are readiness checks complete?</li>
82
83
  <li>Has notice been given, and is any veto recorded?</li>
83
- <li>If this is an emergency, are both importance and immediacy clear?</li>
84
+ <li>If the change type is emergency, are importance and immediacy clear?</li>
84
85
  <li>Is any open risk visible or formally accepted by the Owner?</li>
85
86
  <li>Should the change proceed, be deferred, be cancelled, or need recovery?</li>
86
87
  </ul>
@@ -23,6 +23,7 @@
23
23
  <a class="nav-link" href="./flow.html">Flow</a>
24
24
  <a class="nav-link" href="./objects.html">Records</a>
25
25
  <a class="nav-link" href="./roles.html">Roles</a>
26
+ <a class="nav-link" href="./operating-guide.html">Operating Guide</a>
26
27
  <a class="nav-link" href="./glossary.html">Glossary</a>
27
28
  </nav>
28
29
  </aside>
@@ -23,6 +23,7 @@
23
23
  <a class="nav-link" href="./flow.html">Flow</a>
24
24
  <a class="nav-link" href="./objects.html">Records</a>
25
25
  <a class="nav-link" href="./roles.html">Roles</a>
26
+ <a class="nav-link" href="./operating-guide.html">Operating Guide</a>
26
27
  <a class="nav-link" href="./glossary.html">Glossary</a>
27
28
  </nav>
28
29
  </aside>
@@ -23,6 +23,7 @@
23
23
  <a class="nav-link" href="./flow.html">Flow</a>
24
24
  <a class="nav-link" href="./objects.html">Records</a>
25
25
  <a class="nav-link" href="./roles.html">Roles</a>
26
+ <a class="nav-link" href="./operating-guide.html">Operating Guide</a>
26
27
  <a class="nav-link" href="./glossary.html">Glossary</a>
27
28
  </nav>
28
29
  </aside>
@@ -23,6 +23,7 @@
23
23
  <a class="nav-link" href="./flow.html">Flow</a>
24
24
  <a class="nav-link" href="./objects.html">Records</a>
25
25
  <a class="nav-link" href="./roles.html">Roles</a>
26
+ <a class="nav-link" href="./operating-guide.html">Operating Guide</a>
26
27
  <a class="nav-link" href="./glossary.html">Glossary</a>
27
28
  </nav>
28
29
  </aside>
@@ -23,6 +23,7 @@
23
23
  <a class="nav-link" href="./flow.html">Flow</a>
24
24
  <a class="nav-link" href="./objects.html">Records</a>
25
25
  <a class="nav-link" href="./roles.html">Roles</a>
26
+ <a class="nav-link" href="./operating-guide.html">Operating Guide</a>
26
27
  <a class="nav-link" href="./glossary.html">Glossary</a>
27
28
  </nav>
28
29
  </aside>