dxcomplete 0.1.0 → 0.2.1
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.
- package/README.md +22 -22
- package/dist/init.js +19 -0
- package/dist/mcp/docs.d.ts +18 -2
- package/dist/mcp/docs.js +201 -13
- package/dist/mcp/server.js +761 -47
- package/dist/runtime/check.d.ts +1 -1
- package/dist/runtime/records.d.ts +95 -4
- package/dist/runtime/records.js +640 -11
- package/dist/validate.js +3 -1
- package/docs/codex-integration.md +45 -18
- package/docs/glossary.md +39 -7
- package/docs/index.md +2 -1
- package/docs/model.md +3 -3
- package/docs/operating-guide.md +116 -0
- package/docs/taxonomy.md +12 -6
- package/docs/workflows.md +5 -3
- package/package.json +21 -3
- package/scripts/{dogfood-work-order.mjs → runtime-work-order.mjs} +4 -4
- package/scripts/smoke-mcp-http.mjs +460 -6
- package/src/init.ts +35 -0
- package/src/mcp/docs.ts +234 -14
- package/src/mcp/server.ts +1138 -83
- package/src/runtime/records.ts +914 -12
- package/src/validate.ts +3 -1
- package/templates/AGENTS.md +30 -0
- package/templates/process/controls.yml +10 -6
- package/templates/process/diagrams/01-intake-triage.mmd +5 -5
- package/templates/process/diagrams/02-product-definition.mmd +1 -1
- package/templates/process/diagrams/06-change-release-control.mmd +5 -7
- package/templates/process/diagrams/07-deployment-operations.mmd +2 -2
- package/templates/process/diagrams/08-support-incident-management.mmd +5 -4
- package/templates/process/diagrams/09-problem-improvement.mmd +4 -3
- package/templates/process/diagrams/10-risk-control-management.mmd +6 -4
- package/templates/process/diagrams/11-audit-evidence-capture.mmd +1 -1
- package/templates/process/taxonomy.yml +91 -17
- package/templates/process/workflows.yml +10 -9
- package/website/flow.html +1 -0
- package/website/glossary.html +37 -8
- package/website/index.html +2 -1
- package/website/objects.html +68 -11
- package/website/operating-guide.html +165 -0
- package/website/outcomes.html +1 -0
- package/website/phase-build.html +1 -0
- package/website/phase-elicit.html +1 -0
- package/website/phase-go-live.html +2 -1
- package/website/phase-measure.html +1 -0
- package/website/phase-operate.html +1 -0
- package/website/phase-orient.html +1 -0
- package/website/phase-weigh.html +1 -0
- package/website/roles.html +1 -0
package/src/init.ts
CHANGED
|
@@ -50,6 +50,13 @@ export async function initProject(options: InitOptions): Promise<InitResult> {
|
|
|
50
50
|
|
|
51
51
|
await writeWorkspaceConfig(targetDir, { force, dryRun }, result);
|
|
52
52
|
|
|
53
|
+
await copyFileIfAbsent(
|
|
54
|
+
path.join(packageRoot, "templates", "AGENTS.md"),
|
|
55
|
+
path.join(targetDir, "AGENTS.md"),
|
|
56
|
+
{ dryRun },
|
|
57
|
+
result
|
|
58
|
+
);
|
|
59
|
+
|
|
53
60
|
await copyDirectory(
|
|
54
61
|
path.join(packageRoot, "templates", "next", "pages"),
|
|
55
62
|
path.join(targetDir, "pages"),
|
|
@@ -130,6 +137,34 @@ async function copyFileIfAvailable(
|
|
|
130
137
|
result.written.push(relativeDestination);
|
|
131
138
|
}
|
|
132
139
|
|
|
140
|
+
async function copyFileIfAbsent(
|
|
141
|
+
sourcePath: string,
|
|
142
|
+
destinationPath: string,
|
|
143
|
+
options: Pick<CopyOptions, "dryRun">,
|
|
144
|
+
result: InitResult
|
|
145
|
+
): Promise<void> {
|
|
146
|
+
if (!(await fileExists(sourcePath))) {
|
|
147
|
+
return;
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
const relativeDestination = path.relative(result.targetDir, destinationPath);
|
|
151
|
+
const exists = await fileExists(destinationPath);
|
|
152
|
+
|
|
153
|
+
if (exists) {
|
|
154
|
+
result.skipped.push(relativeDestination);
|
|
155
|
+
return;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
if (options.dryRun) {
|
|
159
|
+
result.planned.push(relativeDestination);
|
|
160
|
+
return;
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
await mkdir(path.dirname(destinationPath), { recursive: true });
|
|
164
|
+
await copyFile(sourcePath, destinationPath);
|
|
165
|
+
result.written.push(relativeDestination);
|
|
166
|
+
}
|
|
167
|
+
|
|
133
168
|
async function writeWorkspaceConfig(
|
|
134
169
|
targetDir: string,
|
|
135
170
|
options: CopyOptions,
|
package/src/mcp/docs.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export const DOC_SOURCE_BASE_URL = "https://dxcomplete.directeddomains.com";
|
|
2
2
|
|
|
3
|
-
export const DOC_PAGE_IDS = ["start_here", "outcomes", "flow", "records", "roles", "glossary"] as const;
|
|
3
|
+
export const DOC_PAGE_IDS = ["start_here", "outcomes", "flow", "records", "roles", "operating_guide", "glossary"] as const;
|
|
4
4
|
|
|
5
5
|
export type DocPageId = (typeof DOC_PAGE_IDS)[number];
|
|
6
6
|
|
|
@@ -90,6 +90,23 @@ type RolesDoc = BaseDocPage & {
|
|
|
90
90
|
}>;
|
|
91
91
|
};
|
|
92
92
|
|
|
93
|
+
type OperatingGuideDoc = BaseDocPage & {
|
|
94
|
+
page: "operating_guide";
|
|
95
|
+
roles: Array<{
|
|
96
|
+
name: string;
|
|
97
|
+
use: string;
|
|
98
|
+
defaultRecords: string[];
|
|
99
|
+
avoid: string[];
|
|
100
|
+
}>;
|
|
101
|
+
recordRouting: Array<{
|
|
102
|
+
situation: string;
|
|
103
|
+
use: string;
|
|
104
|
+
why: string;
|
|
105
|
+
}>;
|
|
106
|
+
itsmBoundaries: string[];
|
|
107
|
+
freshAgentGuidance: string[];
|
|
108
|
+
};
|
|
109
|
+
|
|
93
110
|
export type GlossaryTerm = {
|
|
94
111
|
term: string;
|
|
95
112
|
category: string;
|
|
@@ -101,7 +118,14 @@ type GlossaryDoc = BaseDocPage & {
|
|
|
101
118
|
terms: GlossaryTerm[];
|
|
102
119
|
};
|
|
103
120
|
|
|
104
|
-
export type DocPage =
|
|
121
|
+
export type DocPage =
|
|
122
|
+
| StartHereDoc
|
|
123
|
+
| OutcomesDoc
|
|
124
|
+
| FlowDoc
|
|
125
|
+
| RecordsDoc
|
|
126
|
+
| RolesDoc
|
|
127
|
+
| OperatingGuideDoc
|
|
128
|
+
| GlossaryDoc;
|
|
105
129
|
|
|
106
130
|
export const DOC_REFERENCE: Record<DocPageId, DocPage> = {
|
|
107
131
|
start_here: {
|
|
@@ -282,11 +306,11 @@ export const DOC_REFERENCE: Record<DocPageId, DocPage> = {
|
|
|
282
306
|
axes: [
|
|
283
307
|
{
|
|
284
308
|
name: "Kind of information",
|
|
285
|
-
test: "Claims, goals, and success criteria go to Statement, Expectation, or Requirement; choices go to Decision; actions go to Task; events or controlled history go to matching records such as Change or Risk; otherwise relevant context may go to Journal."
|
|
309
|
+
test: "Claims, goals, and success criteria go to Statement, Expectation, or Requirement; choices go to Decision; actions go to Task; events or controlled history go to matching records such as Change, Incident, Problem, Support Request, Maintenance Schedule, Value Realization, or Risk; otherwise relevant context may go to Journal."
|
|
286
310
|
},
|
|
287
311
|
{
|
|
288
312
|
name: "Process-bound or process-free",
|
|
289
|
-
test: "Statement, Expectation, Requirement, Decision, Task, Change, and Risk can advance work or carry dependencies. Journal is parallel context and does not advance the process by itself."
|
|
313
|
+
test: "Statement, Expectation, Requirement, Decision, Task, Change, Incident, Problem, Support Request, Maintenance Schedule, Value Realization, and Risk can advance work or carry dependencies. Journal is parallel context and does not advance the process by itself."
|
|
290
314
|
},
|
|
291
315
|
{
|
|
292
316
|
name: "Attachment",
|
|
@@ -297,8 +321,15 @@ export const DOC_REFERENCE: Record<DocPageId, DocPage> = {
|
|
|
297
321
|
{ signal: "Desired truth, success criteria, or buildable commitment", record: "Statement, Expectation, or Requirement" },
|
|
298
322
|
{ signal: "Choice between alternatives", record: "Decision" },
|
|
299
323
|
{ signal: "Action someone needs to do", record: "Task" },
|
|
300
|
-
{ signal: "
|
|
324
|
+
{ signal: "Run-side alteration to the service", record: "Change" },
|
|
325
|
+
{ signal: "Specific service-impacting occurrence", record: "Incident" },
|
|
326
|
+
{ signal: "Underlying or recurring cause behind incidents", record: "Problem" },
|
|
327
|
+
{ signal: "User-facing question, request, or issue needing shared follow-up", record: "Support Request" },
|
|
328
|
+
{ signal: "Uncertainty or exposure", record: "Risk" },
|
|
301
329
|
{ signal: "Operational infrastructure state", record: "Operational Registry through Environment and Component records" },
|
|
330
|
+
{ signal: "Recurring operational hygiene", record: "Maintenance Schedule" },
|
|
331
|
+
{ signal: "Measured before/after value", record: "Value Realization" },
|
|
332
|
+
{ signal: "Private question, report, request, correction, or follow-up with DX Complete", record: "DX Complete Ticket" },
|
|
302
333
|
{ signal: "Relevant context with no better home", record: "Journal" }
|
|
303
334
|
],
|
|
304
335
|
edgeCases: [
|
|
@@ -307,7 +338,7 @@ export const DOC_REFERENCE: Record<DocPageId, DocPage> = {
|
|
|
307
338
|
"A note that repeatedly informs decisions or work should be promoted from Journal to the appropriate dedicated record."
|
|
308
339
|
],
|
|
309
340
|
promotion:
|
|
310
|
-
"Journal content that becomes load-bearing should be promoted to Statement, Expectation, Requirement, Decision, Task, Change, Risk, or another dedicated record, then linked back where useful.",
|
|
341
|
+
"Journal content that becomes load-bearing should be promoted to Statement, Expectation, Requirement, Decision, Task, Change, Incident, Problem, Support Request, Maintenance Schedule, Value Realization, Risk, or another dedicated record, then linked back where useful.",
|
|
311
342
|
futureContainers: [
|
|
312
343
|
{
|
|
313
344
|
name: "Operational Registry",
|
|
@@ -335,6 +366,10 @@ export const DOC_REFERENCE: Record<DocPageId, DocPage> = {
|
|
|
335
366
|
name: "Component",
|
|
336
367
|
summary: "One environment-specific operational item, with kind, location details, identifiers, secret pointers, notes, and version history."
|
|
337
368
|
},
|
|
369
|
+
{
|
|
370
|
+
name: "Maintenance Schedule",
|
|
371
|
+
summary: "Recurring operational hygiene, with cadence, start date, rationale, version history, and due state derived from linked completed Changes or Tasks."
|
|
372
|
+
},
|
|
338
373
|
{
|
|
339
374
|
name: "Expectation",
|
|
340
375
|
summary: "The result a person or group expects, including how success will be recognized. Prior versions and review notes can be kept without blocking progress."
|
|
@@ -357,6 +392,10 @@ export const DOC_REFERENCE: Record<DocPageId, DocPage> = {
|
|
|
357
392
|
name: "Benefits",
|
|
358
393
|
summary: "An Owner-authored view of expected benefits. Benefits may be quantified or qualitative."
|
|
359
394
|
},
|
|
395
|
+
{
|
|
396
|
+
name: "Value Realization",
|
|
397
|
+
summary: "Measured before/after value tied to expectations, requirements, or commitments, with derived comparisons for each metric."
|
|
398
|
+
},
|
|
360
399
|
{ name: "Commitment", summary: "An Owner record that commits requirements or expectations into Build, with any reservations visible." },
|
|
361
400
|
{ name: "Deferral", summary: "An Owner record for not committing yet, with conditions that make a future Commitment possible." },
|
|
362
401
|
{ name: "Risk", summary: "Something uncertain that could affect value, delivery, service, or compliance." }
|
|
@@ -372,7 +411,19 @@ export const DOC_REFERENCE: Record<DocPageId, DocPage> = {
|
|
|
372
411
|
},
|
|
373
412
|
{
|
|
374
413
|
name: "Change",
|
|
375
|
-
summary: "A record for a specific alteration to the running service, with plan sections and append-only event history."
|
|
414
|
+
summary: "A record for a specific alteration to the running service, with change type, plan sections, risk and impact including downstream impact where known, append-only event history, and optional Git commit references on result or recovery events."
|
|
415
|
+
},
|
|
416
|
+
{
|
|
417
|
+
name: "Incident",
|
|
418
|
+
summary: "A record for a specific service-impacting or potentially service-impacting occurrence, with status and severity derived from entries."
|
|
419
|
+
},
|
|
420
|
+
{
|
|
421
|
+
name: "Problem",
|
|
422
|
+
summary: "A record for an underlying or recurring cause evidenced by one or more Incidents, with root cause and status derived from entries."
|
|
423
|
+
},
|
|
424
|
+
{
|
|
425
|
+
name: "Support Request",
|
|
426
|
+
summary: "A shared support ledger for a reported user experience, question, request, or issue, with current status derived from entries."
|
|
376
427
|
}
|
|
377
428
|
]
|
|
378
429
|
},
|
|
@@ -406,7 +457,8 @@ export const DOC_REFERENCE: Record<DocPageId, DocPage> = {
|
|
|
406
457
|
},
|
|
407
458
|
{
|
|
408
459
|
name: "Support, incidents, problems, and feedback",
|
|
409
|
-
summary:
|
|
460
|
+
summary:
|
|
461
|
+
"Operational signals can be handled through tickets, incidents, problems, risks, tasks, changes, decisions, or new requirements. Use Incident for a specific occurrence and Problem for an underlying or recurring cause."
|
|
410
462
|
},
|
|
411
463
|
{
|
|
412
464
|
name: "Measurement and estimate refinement",
|
|
@@ -432,6 +484,158 @@ export const DOC_REFERENCE: Record<DocPageId, DocPage> = {
|
|
|
432
484
|
}
|
|
433
485
|
]
|
|
434
486
|
},
|
|
487
|
+
operating_guide: {
|
|
488
|
+
page: "operating_guide",
|
|
489
|
+
title: "Operating Guide",
|
|
490
|
+
sourceUrl: `${DOC_SOURCE_BASE_URL}/operating-guide.html`,
|
|
491
|
+
summary:
|
|
492
|
+
"How each role uses DX Complete in day-to-day work, including record routing and ITSM boundaries.",
|
|
493
|
+
roles: [
|
|
494
|
+
{
|
|
495
|
+
name: "Owner",
|
|
496
|
+
use:
|
|
497
|
+
"Uses DX Complete to set direction, approve expectations when needed, weigh cost and benefit, record Commitment or Deferral, make Decisions, and formally accept risk when the project should own it.",
|
|
498
|
+
defaultRecords: ["Statement", "Expectation", "Benefits", "Value Realization", "Commitment", "Deferral", "Decision", "Risk"],
|
|
499
|
+
avoid: [
|
|
500
|
+
"Do not turn every comment into a requirement.",
|
|
501
|
+
"Do not use approval language for End User feedback.",
|
|
502
|
+
"Do not hide reservations or low-confidence decisions."
|
|
503
|
+
]
|
|
504
|
+
},
|
|
505
|
+
{
|
|
506
|
+
name: "Engineer and Codex assistance",
|
|
507
|
+
use:
|
|
508
|
+
"Uses Requirement to Task as the normal build path. Codex may assist the Engineer, but Codex is a coding-capable tool, not a role.",
|
|
509
|
+
defaultRecords: ["Requirement", "Task", "Decision", "Risk", "Journal"],
|
|
510
|
+
avoid: [
|
|
511
|
+
"Do not create a Change just because implementation work is happening.",
|
|
512
|
+
"Do not use Journal when a Task, Decision, Risk, or Requirement is the real record.",
|
|
513
|
+
"Do not invent Owner intent or End User feedback."
|
|
514
|
+
]
|
|
515
|
+
},
|
|
516
|
+
{
|
|
517
|
+
name: "Tester",
|
|
518
|
+
use:
|
|
519
|
+
"Uses DX Complete to keep verification tied to requirements and visible evidence. Verification can be captured through Task entries, review notes, Risk, Decision, or Journal depending on what is being learned.",
|
|
520
|
+
defaultRecords: ["Task", "Requirement", "Risk", "Decision", "Journal"],
|
|
521
|
+
avoid: [
|
|
522
|
+
"Do not default to Change for testing observations.",
|
|
523
|
+
"Do not treat a failed check as a new requirement unless the expected truth changed.",
|
|
524
|
+
"Do not hide verification uncertainty in free text when it is a Risk."
|
|
525
|
+
]
|
|
526
|
+
},
|
|
527
|
+
{
|
|
528
|
+
name: "Operator and administration",
|
|
529
|
+
use:
|
|
530
|
+
"Uses DX Complete to keep run-side state, service changes, incidents, problems, and operational inventory legible, including Environments, Components, rollout or rollback plans, user permissions, and operational security.",
|
|
531
|
+
defaultRecords: ["Change", "Incident", "Problem", "Environment", "Component", "Maintenance Schedule", "Risk", "Decision"],
|
|
532
|
+
avoid: [
|
|
533
|
+
"Do not paste secret values into records.",
|
|
534
|
+
"Do not use Change for ordinary build work before it alters the running service.",
|
|
535
|
+
"Do not create Incident or Problem merely because work is happening; use them only for operational signal or service-history meaning."
|
|
536
|
+
]
|
|
537
|
+
},
|
|
538
|
+
{
|
|
539
|
+
name: "Support Agent",
|
|
540
|
+
use:
|
|
541
|
+
"Uses DX Complete Ticket as the first stop for user questions, reports, requests, corrections, and follow-ups, then promotes shared follow-up only when needed.",
|
|
542
|
+
defaultRecords: ["Support Request", "DX Complete Ticket", "Statement", "Task", "Incident", "Problem", "Risk", "Decision", "Change", "Journal"],
|
|
543
|
+
avoid: [
|
|
544
|
+
"Do not promote every ticket into shared process work.",
|
|
545
|
+
"Do not use DX Complete Ticket for shared support follow-up when Support Request is the better record.",
|
|
546
|
+
"Do not call a user signal an approval.",
|
|
547
|
+
"Do not create ITSM-style records merely because a user reported something; promote only when the signal has operational or shared follow-up meaning."
|
|
548
|
+
]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
name: "End User",
|
|
552
|
+
use:
|
|
553
|
+
"Uses the service and provides input. Another role captures that input as a Statement, report, request, correction, feedback signal, or ticket when it needs to enter DX Complete.",
|
|
554
|
+
defaultRecords: ["Statement", "DX Complete Ticket"],
|
|
555
|
+
avoid: [
|
|
556
|
+
"Do not treat the End User as a DX Complete operator.",
|
|
557
|
+
"Do not treat End User feedback as authority approval.",
|
|
558
|
+
"Do not expect the End User to choose process records."
|
|
559
|
+
]
|
|
560
|
+
}
|
|
561
|
+
],
|
|
562
|
+
recordRouting: [
|
|
563
|
+
{
|
|
564
|
+
situation: "Normal implementation work",
|
|
565
|
+
use: "Task",
|
|
566
|
+
why: "A Task is the default record for concrete work someone needs to do."
|
|
567
|
+
},
|
|
568
|
+
{
|
|
569
|
+
situation: "Meaningful choice between alternatives",
|
|
570
|
+
use: "Decision",
|
|
571
|
+
why: "A Decision preserves what was chosen and which records informed it."
|
|
572
|
+
},
|
|
573
|
+
{
|
|
574
|
+
situation: "Uncertainty, exposure, or possible harm",
|
|
575
|
+
use: "Risk",
|
|
576
|
+
why: "A Risk keeps the uncertainty visible without pretending it is resolved."
|
|
577
|
+
},
|
|
578
|
+
{
|
|
579
|
+
situation: "Discrete alteration to the running service",
|
|
580
|
+
use: "Change",
|
|
581
|
+
why: "A Change is the current ITSM-style run-side control record."
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
situation: "Specific service-impacting occurrence",
|
|
585
|
+
use: "Incident",
|
|
586
|
+
why: "An Incident keeps response history for one occurrence visible."
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
situation: "Underlying or recurring cause behind one or more incidents",
|
|
590
|
+
use: "Problem",
|
|
591
|
+
why: "A Problem keeps investigation and root-cause history separate from the individual incidents it explains."
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
situation: "User-facing support follow-up",
|
|
595
|
+
use: "Support Request",
|
|
596
|
+
why: "A Support Request keeps the shared support thread visible without turning every report into an Incident."
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
situation: "Operational inventory",
|
|
600
|
+
use: "Environment or Component",
|
|
601
|
+
why: "The Operational Registry shows what exists and where it lives."
|
|
602
|
+
},
|
|
603
|
+
{
|
|
604
|
+
situation: "Recurring operational hygiene",
|
|
605
|
+
use: "Maintenance Schedule",
|
|
606
|
+
why: "A Maintenance Schedule keeps cadence and due state visible while completed Changes or Tasks show what happened."
|
|
607
|
+
},
|
|
608
|
+
{
|
|
609
|
+
situation: "Measured value after work or operation",
|
|
610
|
+
use: "Value Realization",
|
|
611
|
+
why: "Value Realization compares baseline and actual metrics without replacing Benefits or Estimates."
|
|
612
|
+
},
|
|
613
|
+
{
|
|
614
|
+
situation: "Useful context with no better dedicated home",
|
|
615
|
+
use: "Journal",
|
|
616
|
+
why: "Journal is fallback context, not the default home for load-bearing records."
|
|
617
|
+
},
|
|
618
|
+
{
|
|
619
|
+
situation: "Question, report, request, correction, or follow-up with DX Complete",
|
|
620
|
+
use: "DX Complete Ticket",
|
|
621
|
+
why: "A ticket is private to the submitting actor until someone promotes shared follow-up."
|
|
622
|
+
}
|
|
623
|
+
],
|
|
624
|
+
itsmBoundaries: [
|
|
625
|
+
"Change is the current first-class run-side control record. Its risk and impact section should include downstream impact where known: what else may be affected and what depends on what is changing.",
|
|
626
|
+
"Result and recovery events on a Change may include optional Git commit references for the specific execution attempt or rollback. They are recorded as references only; DX Complete does not validate Git commits or assume a Git host.",
|
|
627
|
+
"Incident is the current first-class record for a specific service-impacting or potentially service-impacting occurrence.",
|
|
628
|
+
"Problem is the current first-class record for an underlying or recurring cause evidenced by one or more incidents.",
|
|
629
|
+
"Do not create ITSM-style records merely because work is happening; use them when the information is truly run-side control, operational signal, or service history."
|
|
630
|
+
],
|
|
631
|
+
freshAgentGuidance: [
|
|
632
|
+
"Start by identifying the role being helped and the record that best matches the information.",
|
|
633
|
+
"For Engineer/Codex work, default to Requirement -> Task unless a Decision, Risk, Journal note, or Change is specifically warranted.",
|
|
634
|
+
"For Operator work, use Change only for run-side alteration and Environment or Component for operational inventory.",
|
|
635
|
+
"For Support Agent work, start with DX Complete Ticket before promoting into shared records.",
|
|
636
|
+
"When unsure, ask whether another record will reference or depend on the information. If yes, use the dedicated record."
|
|
637
|
+
]
|
|
638
|
+
},
|
|
435
639
|
glossary: {
|
|
436
640
|
page: "glossary",
|
|
437
641
|
title: "Glossary",
|
|
@@ -442,8 +646,10 @@ export const DOC_REFERENCE: Record<DocPageId, DocPage> = {
|
|
|
442
646
|
{ term: "Benefit Item", category: "Cost and benefit", definition: "One item inside Benefits. It may have an amount or range, or it may be qualitative with no amount." },
|
|
443
647
|
{ term: "Benefits", category: "Cost and benefit", definition: "An Owner-authored benefit record used during Weigh, linked to the requirements or expectations it covers. Benefits may be quantified or qualitative." },
|
|
444
648
|
{ term: "Build", category: "Delivery", definition: "Turning committed requirements into tasks, working changes, and verification." },
|
|
445
|
-
{ term: "
|
|
649
|
+
{ term: "Cadence", category: "Run and support", definition: "How often recurring operational work is expected to happen, such as every month or every quarter." },
|
|
650
|
+
{ term: "Change", category: "Delivery", definition: "A service change record for a discrete alteration to the running service. It records the change type, plan, execution, rollback, notice, veto, decision, result, recovery history, and optional Git commit references without enforcing the operation." },
|
|
446
651
|
{ term: "Change Plan", category: "Delivery", definition: "The part of a Change record that explains what is changing, why, scope, timing, and notice." },
|
|
652
|
+
{ term: "Change Type", category: "Delivery", definition: "The classification of a Change as standard, normal, or emergency. It affects scrutiny and communication but does not enforce the operation." },
|
|
447
653
|
{ term: "Checkpoint", category: "Risk and decisions", definition: "A confirmation point that reduces risk. It can be approved, formally accepted as risk by the Owner, or proceeded past with open risk visible." },
|
|
448
654
|
{ term: "Codex", category: "Delivery", definition: "A coding-capable model that may assist the Engineer. Codex is not a role." },
|
|
449
655
|
{ term: "Commitment", category: "Business context", definition: "An Owner record that says preparation is sufficient to commit requirements or expectations into Build, with any reservations kept visible." },
|
|
@@ -460,7 +666,7 @@ export const DOC_REFERENCE: Record<DocPageId, DocPage> = {
|
|
|
460
666
|
{ term: "Deployment", category: "Delivery", definition: "Putting a release or change into use." },
|
|
461
667
|
{ term: "DX Complete Ticket", category: "Business context", definition: "A private item used to raise a question, report, request, correction, or follow-up with DX Complete." },
|
|
462
668
|
{ term: "Elicit", category: "Business context", definition: "Turning expectations into requirements, dependencies, unknowns, and risk before estimating the work." },
|
|
463
|
-
{ term: "Emergency Change", category: "Delivery", definition: "A
|
|
669
|
+
{ term: "Emergency Change", category: "Delivery", definition: "A Change where normal notice or review is shortened because the situation is important and immediate. Missing rationale remains visible but does not block the record." },
|
|
464
670
|
{ term: "End User", category: "Role", definition: "The person the service is for; uses the service and provides requests, feedback, corrections, and issue reports." },
|
|
465
671
|
{ term: "Engineer", category: "Role", definition: "The role that turns committed requirements into tasks and working changes, either directly or by driving coding-capable tools." },
|
|
466
672
|
{ term: "Environment", category: "Run and support", definition: "A named operating context such as local, staging, or production. Components belong to one Environment so each operating context can be understood separately." },
|
|
@@ -471,24 +677,31 @@ export const DOC_REFERENCE: Record<DocPageId, DocPage> = {
|
|
|
471
677
|
{ term: "Execution Plan", category: "Delivery", definition: "The ordered practical steps inside a Change record for carrying out the change." },
|
|
472
678
|
{ term: "Expectation", category: "Business context", definition: "The result a person or group expects, including how success will be recognized, with approval tracked where needed." },
|
|
473
679
|
{ term: "Feedback", category: "Run and support", definition: "A signal from a user, support interaction, service issue, or observed result." },
|
|
680
|
+
{ term: "Git Commit Reference", category: "Delivery", definition: "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." },
|
|
474
681
|
{ term: "Go Live", category: "Delivery", definition: "Putting a change into use after readiness is confirmed." },
|
|
475
682
|
{ term: "Greenfield", category: "Business context", definition: "Work that starts from a new idea rather than an existing service." },
|
|
476
683
|
{ term: "Handoff", category: "Delivery", definition: "The point where a phase has enough clarity to move into the next phase." },
|
|
477
|
-
{ term: "Incident", category: "Run and support", definition: "
|
|
684
|
+
{ term: "Incident", category: "Run and support", definition: "A specific service-impacting or potentially service-impacting occurrence with response history, current status, and severity derived from ordered entries." },
|
|
685
|
+
{ term: "Incident Entry", category: "Run and support", definition: "One ordered entry in an Incident, such as detected, update, severity, resolved, reopened, or note." },
|
|
478
686
|
{ term: "Informed By", category: "Risk and decisions", definition: "The relationship from a decision to the record that helped inform it." },
|
|
479
687
|
{ term: "Journal", category: "Business context", definition: "A shared workspace record for relevant notes that do not have a better dedicated home. Journal entries are append-only and visible to workspace members." },
|
|
480
688
|
{ term: "Journal Note", category: "Business context", definition: "A raw Journal entry with body text, author, and timestamp. It can be summarized later without being deleted." },
|
|
481
689
|
{ term: "Journal Summary", category: "Business context", definition: "A compact Journal entry that summarizes covered notes and points back to them so older detail remains retrievable." },
|
|
690
|
+
{ term: "Known Error", category: "Run and support", definition: "A Problem state showing an underlying cause is known even if the full improvement is not complete." },
|
|
482
691
|
{ term: "Limited Disclosure", category: "Business context", definition: "A situation where some information is unavailable or cannot be shared." },
|
|
483
692
|
{ term: "Locator", category: "Run and support", definition: "Structured location information for a Component, such as a URL, project, region, host, or route." },
|
|
693
|
+
{ term: "Maintenance Schedule", category: "Run and support", definition: "A recurring operational hygiene record with cadence, start date, rationale, and due state derived from linked completed Changes or Tasks." },
|
|
484
694
|
{ term: "Measure", category: "Cost and benefit", definition: "Compare expected and actual cost or benefit when data is available." },
|
|
695
|
+
{ term: "Measured At", category: "Cost and benefit", definition: "The date or time when a value metric baseline or actual value was measured." },
|
|
485
696
|
{ term: "Measurement", category: "Cost and benefit", definition: "Comparing expected and actual cost or benefit when data is available." },
|
|
697
|
+
{ term: "Normal Change", category: "Delivery", definition: "The default Change type for an assessed alteration to the running service. It may carry a minor, significant, or major impact grade." },
|
|
486
698
|
{ term: "Operate", category: "Run and support", definition: "Run the service, support users, and respond to issues." },
|
|
487
699
|
{ term: "Operational Registry", category: "Run and support", definition: "The inventory of Environments and Components that shows what exists, where it lives, and which secret locations are relevant. It is not monitoring, diagnostics, a secret vault, an event log, or a runbook." },
|
|
488
700
|
{ term: "Operator", category: "Role", definition: "The role that releases, deploys, monitors, runs the service, and manages users, permissions, settings, provisioning, and run-side security." },
|
|
489
701
|
{ term: "Outcome", category: "Business context", definition: "The result the work is meant to create or improve." },
|
|
490
702
|
{ term: "Owner", category: "Role", definition: "The role that sets authority, priority, outcome direction, requirements, product validation direction, budget commitment, escalation direction, and formal risk acceptance." },
|
|
491
|
-
{ term: "Problem", category: "Run and support", definition: "An underlying or
|
|
703
|
+
{ term: "Problem", category: "Run and support", definition: "An underlying or recurring cause evidenced by one or more Incidents, with investigation, root-cause, known-error, and resolution history." },
|
|
704
|
+
{ term: "Problem Entry", category: "Run and support", definition: "One ordered entry in a Problem, such as identified, investigation, root cause, known error, resolved, reopened, or note." },
|
|
492
705
|
{ term: "Proceeding Past an Open Checkpoint", category: "Risk and decisions", definition: "Moving forward while an approval, readiness concern, or other checkpoint is still open. The risk remains visible and is not formally accepted." },
|
|
493
706
|
{ term: "Product Validation", category: "Delivery", definition: "Confirming that the completed work achieves the intended outcome." },
|
|
494
707
|
{ term: "QA Verification", category: "Delivery", definition: "Checking that completed work meets the requirements and success criteria." },
|
|
@@ -502,21 +715,28 @@ export const DOC_REFERENCE: Record<DocPageId, DocPage> = {
|
|
|
502
715
|
{ term: "Requirement Set", category: "Business context", definition: "The group of requirements being estimated, committed, built, or stopped together." },
|
|
503
716
|
{ term: "Reservation", category: "Business context", definition: "A concern recorded inside a Commitment when the Owner moves forward despite it." },
|
|
504
717
|
{ term: "Review Note", category: "Delivery", definition: "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." },
|
|
505
|
-
{ term: "Risk", category: "Risk and decisions", definition: "Something uncertain that could affect value, delivery, service, or
|
|
718
|
+
{ term: "Risk", category: "Risk and decisions", definition: "Something uncertain that could affect value, delivery, service, compliance, or operations. Current risk state comes from ordered entries." },
|
|
506
719
|
{ term: "Risk Acceptance", category: "Risk and decisions", definition: "An Owner decision to own an open risk on the project's behalf. It is different from simply proceeding past an open checkpoint." },
|
|
720
|
+
{ term: "Risk Entry", category: "Risk and decisions", definition: "One ordered entry in a Risk, such as identified, assessment, treatment, monitor note, closed, or reopened." },
|
|
721
|
+
{ term: "Risk Treatment", category: "Risk and decisions", definition: "The chosen response to a Risk: accept, mitigate, transfer, or avoid. Formal acceptance is Owner-only." },
|
|
507
722
|
{ term: "Rollback Plan", category: "Delivery", definition: "The part of a Change record that explains how to reverse or recover if the change fails or should not remain in use." },
|
|
508
723
|
{ term: "Roll-up", category: "Cost and benefit", definition: "Grouped totals from quantified cost or benefit items, keeping one-time amounts, recurring amounts, periods, and currencies distinct." },
|
|
509
724
|
{ term: "Secret Pointer", category: "Run and support", definition: "A reference to where a secret is stored and what it is called. It should not contain the secret value." },
|
|
725
|
+
{ term: "Root Cause", category: "Run and support", definition: "The underlying cause recorded in a Problem when investigation identifies why one or more incidents occurred." },
|
|
726
|
+
{ term: "Standard Change", category: "Delivery", definition: "A low-risk, pre-understood, repeatable Change type for work that can use a lighter path while still preserving the record." },
|
|
510
727
|
{ term: "Statement", category: "Business context", definition: "A person's own words before they are interpreted or translated, kept as the traceable root for expectations and downstream work." },
|
|
511
728
|
{ term: "Success Criteria", category: "Delivery", definition: "The conditions used to decide whether completed work satisfies the need." },
|
|
512
729
|
{ term: "Support Agent", category: "Role", definition: "The role that helps users, captures signals, and routes questions, feedback, and issues to the right follow-up." },
|
|
513
|
-
{ term: "Support
|
|
730
|
+
{ term: "Support Request", category: "Run and support", definition: "A shared support record for a reported user experience, question, request, or issue that needs workspace-visible follow-up." },
|
|
731
|
+
{ term: "Support Request Entry", category: "Run and support", definition: "One ordered entry in a Support Request, such as raised, triage, update, escalated, resolved, reopened, or note." },
|
|
514
732
|
{ term: "Task", category: "Delivery", definition: "A piece of work with an entry history. The current status comes from the latest status-change entry." },
|
|
515
733
|
{ term: "Task Entry", category: "Delivery", definition: "One ordered entry in a Task, such as a comment, note, or status change." },
|
|
516
734
|
{ term: "Tester", category: "Role", definition: "The role that checks completed work against requirements and success criteria." },
|
|
517
735
|
{ term: "Transformation", category: "Business context", definition: "Improving an existing service or way of working." },
|
|
518
736
|
{ term: "Unknowns", category: "Business context", definition: "Important questions that are not answered yet." },
|
|
519
737
|
{ term: "Veto", category: "Risk and decisions", definition: "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." },
|
|
738
|
+
{ term: "Value Metric", category: "Cost and benefit", definition: "One before/after measure inside Value Realization, with a baseline, optional actual value, unit, direction, and measured dates." },
|
|
739
|
+
{ term: "Value Realization", category: "Cost and benefit", definition: "A record that compares baseline and actual value metrics after work or operation when measurement is available." },
|
|
520
740
|
{ term: "Version History", category: "Risk and decisions", definition: "Prior versions kept when an expectation or requirement changes, so the current wording can be understood without losing what came before." },
|
|
521
741
|
{ term: "Weigh", category: "Business context", definition: "The phase where cost, value, risk, and confidence are compared before recording a Commitment or Deferral." },
|
|
522
742
|
{ term: "Workspace", category: "Business context", definition: "The container for one service and the work connected to it." }
|