@thebackstoryis/engineering-with-ai 0.2.9
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/Docs/README.md +50 -0
- package/Docs/adoption/consultancy-and-multi-project-rollout.md +135 -0
- package/Docs/adoption/non-technical-team-guide.md +126 -0
- package/Docs/archaeology-technology-and-hosting-discovery.md +212 -0
- package/Docs/blast-radius-and-impact-routing-guide.md +325 -0
- package/Docs/blueprints/internal-blueprint-catalogue.md +146 -0
- package/Docs/blueprints/maintaining-organisation-blueprints.md +154 -0
- package/Docs/blueprints/validation-and-troubleshooting.md +168 -0
- package/Docs/cli-reference.md +113 -0
- package/Docs/completed-phase-evidence-amendments.md +74 -0
- package/Docs/consultancy-network-rollout-control-plane-guide.md +202 -0
- package/Docs/context-aware-delivery-companion-guide.md +198 -0
- package/Docs/context-aware-delivery-companion-user-guide.md +184 -0
- package/Docs/context-management-and-token-efficiency.md +113 -0
- package/Docs/design-systems/design-system-implementation-guide.md +85 -0
- package/Docs/design-systems/design-system-pack-authoring-guide.md +95 -0
- package/Docs/design-systems/design-system-review-guide.md +51 -0
- package/Docs/design-systems/design-system-user-guide.md +96 -0
- package/Docs/design-systems/product-owner-guide.md +49 -0
- package/Docs/designing-organisation-blueprint-packs.md +384 -0
- package/Docs/developer-delivery-guide.md +224 -0
- package/Docs/error-reporting-guide.md +110 -0
- package/Docs/error-reporting-provider-guide.md +49 -0
- package/Docs/examples/error-report-adapter.md +70 -0
- package/Docs/examples/meeting-review.md +76 -0
- package/Docs/examples/minimal-design-system.md +67 -0
- package/Docs/examples/prototype-review-inputs.md +175 -0
- package/Docs/examples/reproducible-archaeology-depth-example.md +144 -0
- package/Docs/examples/test-scenario-input.md +68 -0
- package/Docs/examples/worked-examples.md +147 -0
- package/Docs/existing-project-onboarding-guide.md +214 -0
- package/Docs/explanation/core-concepts.md +26 -0
- package/Docs/explanation/delivery-workflow.md +48 -0
- package/Docs/governance/governance-team-guide.md +139 -0
- package/Docs/governed-starter-project-materialisation-guide.md +284 -0
- package/Docs/guide-catalogue.md +117 -0
- package/Docs/guided-discovery-facilitator-guide.md +172 -0
- package/Docs/guided-intent-workspace-guide.md +109 -0
- package/Docs/guided-phase-evidence-drafting-guide.md +119 -0
- package/Docs/human-approval-and-assurance-guide.md +146 -0
- package/Docs/knowledge-proposals-implementer-guide.md +106 -0
- package/Docs/knowledge-proposals-user-guide.md +247 -0
- package/Docs/maintainers/context-benchmarks.md +29 -0
- package/Docs/maintainers/contributing.md +58 -0
- package/Docs/maintainers/evidence-depth-acceptance.md +72 -0
- package/Docs/maintainers/verification-walkthroughs.md +104 -0
- package/Docs/meeting-evidence-implementer-guide.md +132 -0
- package/Docs/meeting-evidence-user-guide.md +200 -0
- package/Docs/operations/dashboard-and-delivery-state.md +153 -0
- package/Docs/operations/dashboard-configuration.md +87 -0
- package/Docs/operations/installation-updating-and-entitlements.md +135 -0
- package/Docs/operations/premium-personas-setup.md +76 -0
- package/Docs/operations/troubleshooting-and-recovery.md +205 -0
- package/Docs/organisation-rollout-guide.md +142 -0
- package/Docs/persona-entitlement-provider-guide.md +199 -0
- package/Docs/persona-guided-prototype-iteration.md +129 -0
- package/Docs/personas/organisation-specific-personas.md +103 -0
- package/Docs/personas/persona-authoring-cookbook.md +176 -0
- package/Docs/personas/persona-engagement-ui.md +133 -0
- package/Docs/personas/persona-governance.md +118 -0
- package/Docs/platform-export-analysis-guide.md +336 -0
- package/Docs/policies/governance-owner-guide.md +36 -0
- package/Docs/policies/implementation-guide.md +42 -0
- package/Docs/policies/organisation-policy-design-gates.md +58 -0
- package/Docs/policies/policy-pack-authoring-guide.md +108 -0
- package/Docs/policies/product-owner-guide.md +43 -0
- package/Docs/policies/technical-owner-guide.md +37 -0
- package/Docs/product-owner-guide.md +327 -0
- package/Docs/project-portfolio-orchestration-guide.md +199 -0
- package/Docs/quality/manual-qa-and-acceptance.md +162 -0
- package/Docs/quality/persona-driven-test-scenarios.md +172 -0
- package/Docs/quality/reproducible-archaeology-depth-review-checklist.md +89 -0
- package/Docs/reference/capabilities-and-project-layout.md +678 -0
- package/Docs/reference/cli-and-configuration.md +398 -0
- package/Docs/reference/contributions-api.md +23 -0
- package/Docs/reference/security-adapter-authoring.md +81 -0
- package/Docs/reference/starter-adapter-authoring.md +74 -0
- package/Docs/repository-source-map-guide.md +381 -0
- package/Docs/reproducible-archaeology-and-discovery-depth.md +292 -0
- package/Docs/screen-prototype-creation-guide.md +324 -0
- package/Docs/security-validation-guide.md +353 -0
- package/Docs/solution-readiness-review-guide.md +123 -0
- package/Docs/standards/project-standards-authoring.md +157 -0
- package/Docs/team-hub-guide.md +162 -0
- package/Docs/team-hub-resource-registry-guide.md +167 -0
- package/Docs/tutorials/first-delivery.md +83 -0
- package/Docs/tutorials/first-session.md +62 -0
- package/Docs/using-lifecycle-hooks.md +381 -0
- package/Docs/working-with-personas.md +274 -0
- package/LICENSE +165 -0
- package/README.md +96 -0
- package/agents-src/claude/ewai-security-reviewer.md +15 -0
- package/bin/ewai +5 -0
- package/config/archaeology-record-families.yaml +59 -0
- package/config/delivery-artifacts.yaml +121 -0
- package/config/delivery-stages.yaml +77 -0
- package/config/design-system.schema.json +46 -0
- package/config/error-reporting.schema.json +79 -0
- package/config/evidence-depth.schema.json +53 -0
- package/config/intent.schema.json +90 -0
- package/config/knowledge-proposals-proposal.schema.json +34 -0
- package/config/lifecycle-event.schema.json +68 -0
- package/config/lifecycle-handler.schema.json +45 -0
- package/config/lifecycle-hook-ack.schema.json +19 -0
- package/config/meeting-evidence-candidate.schema.json +102 -0
- package/config/organisation-policy.schema.json +137 -0
- package/config/pack.schema.json +250 -0
- package/config/persona-pack.schema.json +21 -0
- package/config/persona.schema.json +17 -0
- package/config/policy-evaluation.schema.json +77 -0
- package/config/policy-facts.schema.json +140 -0
- package/config/portfolio.schema.json +68 -0
- package/config/project.schema.json +313 -0
- package/config/prototype-iteration.schema.json +128 -0
- package/config/rollout.schema.json +87 -0
- package/config/security-adapter.schema.json +31 -0
- package/config/security-scan-request.schema.json +64 -0
- package/config/security-scan-response.schema.json +52 -0
- package/config/security-validation-policy.schema.json +74 -0
- package/config/starter-source-acknowledgement.schema.json +13 -0
- package/config/starter-source-adapter.schema.json +38 -0
- package/config/starter-source-request.schema.json +61 -0
- package/package.json +77 -0
- package/packs/core/pack.yaml +7 -0
- package/packs/design-systems/default/experience-promise.md +9 -0
- package/packs/design-systems/default/intentional-review.md +10 -0
- package/packs/design-systems/default/interaction-and-entry.md +9 -0
- package/packs/design-systems/default/meaningful-content-and-states.md +9 -0
- package/packs/design-systems/default/pack.yaml +44 -0
- package/packs/design-systems/default/principles.md +10 -0
- package/packs/personas/core/pack.yaml +7 -0
- package/packs/personas/core/personas/archaeologist.md +37 -0
- package/packs/personas/core/personas/end-user.md +17 -0
- package/packs/personas/core/personas/maintainer.md +17 -0
- package/packs/personas/core/personas/operator.md +17 -0
- package/packs/personas/core/personas/specs-knowledge-curator.md +35 -0
- package/packs/technologies/laravel/pack.yaml +30 -0
- package/packs/technologies/laravel-nuxt/pack.yaml +30 -0
- package/packs/technologies/nuxt/pack.yaml +30 -0
- package/packs/technologies/power-platform/pack.yaml +31 -0
- package/packs/technologies/salesforce/pack.yaml +25 -0
- package/public/app.js +4896 -0
- package/public/apple-touch-icon.png +0 -0
- package/public/assets/backstory-icon.png +0 -0
- package/public/dashboard-navigation.js +98 -0
- package/public/favicon-16.png +0 -0
- package/public/favicon-32.png +0 -0
- package/public/favicon.ico +0 -0
- package/public/index.html +789 -0
- package/public/styles.css +2693 -0
- package/public/team-hub/app.js +202 -0
- package/public/team-hub/index.html +79 -0
- package/public/team-hub/styles.css +90 -0
- package/scripts/publication-check.mjs +140 -0
- package/scripts/setup.mjs +21 -0
- package/skills-src/ewai-archaeology/SKILL.md +334 -0
- package/skills-src/ewai-archaeology/agents/openai.yaml +4 -0
- package/skills-src/ewai-archaeology/references/archaeology-contract.md +201 -0
- package/skills-src/ewai-archaeology/references/lifecycle-reconstruction.md +177 -0
- package/skills-src/ewai-archaeology/references/maximum-detail-reconstruction.md +97 -0
- package/skills-src/ewai-archaeology/references/model-routing.md +26 -0
- package/skills-src/ewai-architecture/SKILL.md +108 -0
- package/skills-src/ewai-architecture/agents/openai.yaml +4 -0
- package/skills-src/ewai-architecture/references/architecture-contract.md +176 -0
- package/skills-src/ewai-context/SKILL.md +68 -0
- package/skills-src/ewai-context/agents/openai.yaml +4 -0
- package/skills-src/ewai-context-import/SKILL.md +118 -0
- package/skills-src/ewai-context-import/agents/openai.yaml +4 -0
- package/skills-src/ewai-context-import/references/context-import-contract.md +106 -0
- package/skills-src/ewai-dashboard-configuration/SKILL.md +20 -0
- package/skills-src/ewai-deliver/SKILL.md +122 -0
- package/skills-src/ewai-deliver/references/delivery-evidence.md +92 -0
- package/skills-src/ewai-deliver/references/phase-routing.md +31 -0
- package/skills-src/ewai-design-system-apply/SKILL.md +27 -0
- package/skills-src/ewai-design-system-apply/agents/openai.yaml +4 -0
- package/skills-src/ewai-design-system-apply/references/application-contract.md +36 -0
- package/skills-src/ewai-design-system-author/SKILL.md +28 -0
- package/skills-src/ewai-design-system-author/agents/openai.yaml +4 -0
- package/skills-src/ewai-design-system-author/references/authoring-contract.md +38 -0
- package/skills-src/ewai-design-system-review/SKILL.md +26 -0
- package/skills-src/ewai-design-system-review/agents/openai.yaml +4 -0
- package/skills-src/ewai-design-system-review/references/review-contract.md +40 -0
- package/skills-src/ewai-error-reporting/SKILL.md +46 -0
- package/skills-src/ewai-error-reporting/agents/openai.yaml +4 -0
- package/skills-src/ewai-error-reporting/references/provider-contract.md +74 -0
- package/skills-src/ewai-evidence-depth/SKILL.md +72 -0
- package/skills-src/ewai-evidence-depth/agents/openai.yaml +4 -0
- package/skills-src/ewai-evidence-depth/references/evidence-depth-contract.md +127 -0
- package/skills-src/ewai-intent/SKILL.md +68 -0
- package/skills-src/ewai-intent/agents/openai.yaml +4 -0
- package/skills-src/ewai-intent/references/intent-contract.md +42 -0
- package/skills-src/ewai-knowledge-proposals/SKILL.md +105 -0
- package/skills-src/ewai-knowledge-proposals/agents/openai.yaml +4 -0
- package/skills-src/ewai-knowledge-proposals/references/proposal-contract.md +59 -0
- package/skills-src/ewai-meeting-evidence/SKILL.md +106 -0
- package/skills-src/ewai-meeting-evidence/agents/openai.yaml +4 -0
- package/skills-src/ewai-meeting-evidence/references/candidate-contract.md +64 -0
- package/skills-src/ewai-organisation-policy/SKILL.md +62 -0
- package/skills-src/ewai-organisation-policy/agents/openai.yaml +4 -0
- package/skills-src/ewai-organisation-policy/references/policy-contract.md +94 -0
- package/skills-src/ewai-palace-housekeeping/SKILL.md +55 -0
- package/skills-src/ewai-palace-housekeeping/agents/openai.yaml +4 -0
- package/skills-src/ewai-persona-entitlement/SKILL.md +60 -0
- package/skills-src/ewai-persona-entitlement/agents/openai.yaml +4 -0
- package/skills-src/ewai-phase-evidence/SKILL.md +79 -0
- package/skills-src/ewai-phase-evidence/agents/openai.yaml +4 -0
- package/skills-src/ewai-pipeline/SKILL.md +130 -0
- package/skills-src/ewai-pipeline/agents/openai.yaml +4 -0
- package/skills-src/ewai-pipeline/references/cli.md +86 -0
- package/skills-src/ewai-pipeline/references/specs-contract.md +16 -0
- package/skills-src/ewai-portfolio/SKILL.md +70 -0
- package/skills-src/ewai-portfolio/agents/openai.yaml +4 -0
- package/skills-src/ewai-portfolio/references/portfolio-contract.md +67 -0
- package/skills-src/ewai-project-discovery/SKILL.md +95 -0
- package/skills-src/ewai-project-discovery/agents/openai.yaml +4 -0
- package/skills-src/ewai-project-discovery/references/discovery-contract.md +34 -0
- package/skills-src/ewai-prototype-iteration/SKILL.md +30 -0
- package/skills-src/ewai-prototype-iteration/agents/openai.yaml +4 -0
- package/skills-src/ewai-prototype-iteration/references/review-contract.md +49 -0
- package/skills-src/ewai-retro/SKILL.md +48 -0
- package/skills-src/ewai-retro/agents/openai.yaml +4 -0
- package/skills-src/ewai-retro/references/asset-routing.md +14 -0
- package/skills-src/ewai-rollout/SKILL.md +74 -0
- package/skills-src/ewai-rollout/agents/openai.yaml +4 -0
- package/skills-src/ewai-rollout/references/rollout-contract.md +74 -0
- package/skills-src/ewai-shape-intents/SKILL.md +84 -0
- package/skills-src/ewai-shape-intents/agents/openai.yaml +4 -0
- package/skills-src/ewai-shape-intents/references/intent-mapping-contract.md +109 -0
- package/skills-src/ewai-solution-readiness/SKILL.md +55 -0
- package/skills-src/ewai-solution-readiness/agents/openai.yaml +4 -0
- package/skills-src/ewai-standards-check/SKILL.md +93 -0
- package/skills-src/ewai-standards-check/agents/openai.yaml +4 -0
- package/skills-src/ewai-standards-check/references/report-contract.md +116 -0
- package/skills-src/ewai-test-scenarios/SKILL.md +94 -0
- package/skills-src/ewai-test-scenarios/agents/openai.yaml +4 -0
- package/skills-src/ewai-test-scenarios/references/scenario-contract.md +88 -0
- package/src/afk-worker.mjs +16 -0
- package/src/archaeology.mjs +1333 -0
- package/src/checkin.mjs +261 -0
- package/src/cli.mjs +2427 -0
- package/src/companion-guidance.mjs +257 -0
- package/src/companion-opening.mjs +62 -0
- package/src/companion.mjs +256 -0
- package/src/context.mjs +210 -0
- package/src/dashboard-preferences.mjs +80 -0
- package/src/delivery-artifacts.mjs +204 -0
- package/src/delivery-documents.mjs +248 -0
- package/src/delivery-gates.mjs +317 -0
- package/src/delivery.mjs +1433 -0
- package/src/design-system-application.mjs +291 -0
- package/src/design-system-authoring.mjs +101 -0
- package/src/design-systems.mjs +466 -0
- package/src/discovery.mjs +1314 -0
- package/src/error-reporting.mjs +323 -0
- package/src/evidence-depth.mjs +543 -0
- package/src/execution-state.mjs +243 -0
- package/src/install.mjs +166 -0
- package/src/intent-dependencies.mjs +117 -0
- package/src/intent-maps.mjs +402 -0
- package/src/intents.mjs +747 -0
- package/src/knowledge-proposals.mjs +717 -0
- package/src/launcher.mjs +51 -0
- package/src/meeting-evidence.mjs +703 -0
- package/src/network-rollout.mjs +386 -0
- package/src/organisation-blueprints.mjs +438 -0
- package/src/organisation-policies.mjs +448 -0
- package/src/packs.mjs +44 -0
- package/src/paths.mjs +62 -0
- package/src/persona-entitlements.mjs +438 -0
- package/src/persona-licence-config.mjs +98 -0
- package/src/persona-website-provider.mjs +134 -0
- package/src/persona-zip.mjs +87 -0
- package/src/personas.mjs +159 -0
- package/src/platform-metadata-analysis.mjs +314 -0
- package/src/policy-design-gates.mjs +623 -0
- package/src/policy-gate-integration.mjs +318 -0
- package/src/portfolio.mjs +509 -0
- package/src/power-platform-source-map.mjs +190 -0
- package/src/project.mjs +449 -0
- package/src/prototype-iterations.mjs +730 -0
- package/src/repository-source-map.mjs +603 -0
- package/src/runtime/afk-conductor.mjs +973 -0
- package/src/runtime/context-assembly.mjs +457 -0
- package/src/runtime/context-benchmarks.mjs +115 -0
- package/src/runtime/dashboard-actions.mjs +109 -0
- package/src/runtime/dashboard-handoffs.mjs +149 -0
- package/src/runtime/dashboard-server.mjs +1272 -0
- package/src/runtime/dashboard.mjs +197 -0
- package/src/runtime/database.mjs +789 -0
- package/src/runtime/error-reporting.mjs +581 -0
- package/src/runtime/evidence-depth-workspace.mjs +412 -0
- package/src/runtime/execution-leases.mjs +299 -0
- package/src/runtime/guided-discovery.mjs +350 -0
- package/src/runtime/guided-intents.mjs +517 -0
- package/src/runtime/impact-analysis.mjs +535 -0
- package/src/runtime/intents.mjs +222 -0
- package/src/runtime/knowledge.mjs +86 -0
- package/src/runtime/lifecycle-hooks.mjs +1239 -0
- package/src/runtime/mcp-config.mjs +110 -0
- package/src/runtime/mcp-server.mjs +1885 -0
- package/src/runtime/palace.mjs +362 -0
- package/src/runtime/paths.mjs +58 -0
- package/src/runtime/persona-engagement.mjs +255 -0
- package/src/runtime/phase-contributions.mjs +594 -0
- package/src/runtime/policy-workspace.mjs +170 -0
- package/src/runtime/prototype-iterations.mjs +235 -0
- package/src/runtime/provider-adapters.mjs +163 -0
- package/src/runtime/repository-index.mjs +838 -0
- package/src/runtime/runs.mjs +185 -0
- package/src/runtime/security-validation.mjs +1230 -0
- package/src/runtime/starter-materialisation.mjs +1155 -0
- package/src/runtime/team-hub-client.mjs +479 -0
- package/src/runtime/team-hub-database.mjs +288 -0
- package/src/runtime/team-hub-server.mjs +191 -0
- package/src/runtime/team-hub.mjs +110 -0
- package/src/runtime/tree-sitter-index.mjs +390 -0
- package/src/runtime/version.mjs +1 -0
- package/src/runtime/work.mjs +633 -0
- package/src/salesforce-source-map.mjs +212 -0
- package/src/security-validation-config.mjs +224 -0
- package/src/solution-readiness.mjs +620 -0
- package/src/starter-materialisation-contract.mjs +407 -0
- package/src/task-graph.mjs +544 -0
- package/src/team-hub-resources.mjs +239 -0
- package/src/team-hub.mjs +242 -0
- package/src/test-scenarios.mjs +622 -0
- package/src/validation-config.mjs +289 -0
- package/templates/SPECS/1.Scope/personas/registry.yaml +12 -0
- package/templates/SPECS/5.Strategy/patterns/context-packet.md +119 -0
- package/templates/SPECS/6.Build/_tracker-template.md +16 -0
- package/templates/SPECS/pipeline.yaml +62 -0
- package/templates/discovery-answers.yaml +86 -0
- package/templates/intent-body.md +21 -0
- package/tests/fixtures/context-benchmarks.json +9 -0
package/Docs/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Engineering With AI guides
|
|
2
|
+
|
|
3
|
+
Use these guides to get EWAI running, describe the work you want to do and take it through delivery. You don't need to read the whole library before starting.
|
|
4
|
+
|
|
5
|
+
Conversation is the normal way to work with EWAI. Describe what you need in your AI host; the skills help it choose the workflow, ask for missing information, and run the supporting commands. Command examples are available when you want direct control, but you don't have to learn them first. Your choices and approvals still guide the work.
|
|
6
|
+
|
|
7
|
+
For feature delivery, **`ewai-deliver` coordinates the full fourteen-stage workflow**, bringing in specialist skills as needed and resuming from the project's recorded state. You don't need to run each stage yourself. See the [delivery guide](developer-delivery-guide.md) for the stages and the decisions you'll be asked to make.
|
|
8
|
+
|
|
9
|
+
## New to EWAI?
|
|
10
|
+
|
|
11
|
+
1. [Install EWAI](operations/installation-updating-and-entitlements.md) and open it in your project folder.
|
|
12
|
+
2. For existing code, follow [existing-project onboarding](existing-project-onboarding-guide.md). EWAI will offer Archaeology to reconstruct missing documentation; you can decline it.
|
|
13
|
+
3. For a new project, follow [your first session](tutorials/first-session.md), then [your first delivery](tutorials/first-delivery.md).
|
|
14
|
+
4. Read [how the fourteen stages fit together](explanation/delivery-workflow.md) when you want to understand the process. [Core concepts](explanation/core-concepts.md) explains the terms as you need them.
|
|
15
|
+
|
|
16
|
+
The [Product Owner guide](product-owner-guide.md) covers deeper discovery and optional shared guidance. Bring the problem, examples and people who can help—not a finished technical specification.
|
|
17
|
+
|
|
18
|
+
If you have a persona licence, [set it up before the analysis](operations/premium-personas-setup.md) you want it to support. Premium personas are optional.
|
|
19
|
+
|
|
20
|
+
## What are you here to do?
|
|
21
|
+
|
|
22
|
+
| Your task | Start here |
|
|
23
|
+
| --- | --- |
|
|
24
|
+
| Describe a feature or improve an existing idea | [Use Intent Studio](guided-intent-workspace-guide.md) |
|
|
25
|
+
| Decide what to tackle next | [Use the Companion](context-aware-delivery-companion-user-guide.md) |
|
|
26
|
+
| Implement an agreed change | [Developer delivery guide](developer-delivery-guide.md) |
|
|
27
|
+
| Check that the result works for people | [Manual QA and acceptance](quality/manual-qa-and-acceptance.md) |
|
|
28
|
+
|
|
29
|
+
If you're contributing without an engineering background, use the [non-technical team guide](adoption/non-technical-team-guide.md). For examples of the wider workflow, see [worked examples](examples/worked-examples.md).
|
|
30
|
+
|
|
31
|
+
## Make the dashboard work for you
|
|
32
|
+
|
|
33
|
+
[Choose which views you need](operations/dashboard-configuration.md). Portfolio, Team Hub, policy tools and the other advanced views are optional and start hidden. Showing a view doesn't configure the service behind it; hiding one doesn't remove checks your project requires.
|
|
34
|
+
|
|
35
|
+
## Something isn't working?
|
|
36
|
+
|
|
37
|
+
Start with [troubleshooting and recovery](operations/troubleshooting-and-recovery.md). For a problem that needs support, [prepare a private error report](error-reporting-guide.md) and review it before sharing.
|
|
38
|
+
|
|
39
|
+
## Find a specialist guide
|
|
40
|
+
|
|
41
|
+
The [complete guide catalogue](guide-catalogue.md) separates everyday use, engineering, team administration and EWAI maintenance. It includes the command reference, pack authoring, policy setup, integrations and verification notes. Choose what fits your task; the catalogue isn't a checklist.
|
|
42
|
+
|
|
43
|
+
## A few boundaries worth knowing
|
|
44
|
+
|
|
45
|
+
- **SPECS keeps the project's agreed knowledge.** Runtime indexes can be rebuilt; don't use a database edit to change an intent or approval.
|
|
46
|
+
- **Personas help you think.** Their suggestions aren't evidence from real users or permission to build.
|
|
47
|
+
- **Review and approval are separate.** Tests and a promising prototype don't replace Build approval or human acceptance.
|
|
48
|
+
- **An installed pack isn't automatically suitable.** Review shared guidance before adopting it. Executable adapters need explicit registration and run with your operating-system permissions; they aren't OS-sandboxed.
|
|
49
|
+
|
|
50
|
+
If you're changing EWAI itself, start in the [maintainer section](guide-catalogue.md#maintaining-ewai), not the application delivery instructions.
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# Consultancy and multi-project rollout guide
|
|
2
|
+
|
|
3
|
+
Use this guide when one delivery organisation supports several clients, business units, or independent projects with EWAI.
|
|
4
|
+
|
|
5
|
+
The engagement practices below are recommendations, not a required commercial service or a special consulting mode in EWAI. Teams can install and operate EWAI themselves. Where you operate it for a client, agree who owns the workspace, evidence and decisions before processing their material.
|
|
6
|
+
|
|
7
|
+
## The isolation principle
|
|
8
|
+
|
|
9
|
+
Several repositories can belong to one project; several clients shouldn't be treated as one project just because the same team supports them. Use separate project records and runtimes for independently owned work.
|
|
10
|
+
|
|
11
|
+
When you need an overview, [Portfolio](../project-portfolio-orchestration-guide.md) compares configured local projects, [Team Hub](../team-hub-guide.md) shares explicitly published summaries and resources, and [Governed Rollout](../consultancy-network-rollout-control-plane-guide.md) compares adoption against agreed baselines. These views are optional; enable them through [Configuration](../operations/dashboard-configuration.md).
|
|
12
|
+
|
|
13
|
+
Reusable methodology may cross project boundaries. Project truth, client evidence, decisions, credentials, and runtime state must not.
|
|
14
|
+
|
|
15
|
+
Each project should resolve its own:
|
|
16
|
+
|
|
17
|
+
- project root and configured SPECS root;
|
|
18
|
+
- repositories and ownership;
|
|
19
|
+
- Organisation Blueprint selection and receipt;
|
|
20
|
+
- project personas and evidence;
|
|
21
|
+
- validation providers and approval policy;
|
|
22
|
+
- delivery state, dashboard, indexes, and logs;
|
|
23
|
+
- data classification and AI-processing permission.
|
|
24
|
+
|
|
25
|
+
Never carry a path, persona, source document, or delivery state from one client project into another merely because the same consultant or machine is involved.
|
|
26
|
+
|
|
27
|
+
## Design three knowledge layers
|
|
28
|
+
|
|
29
|
+
| Layer | Suitable content | Owner |
|
|
30
|
+
| --- | --- | --- |
|
|
31
|
+
| EWAI framework | Portable method, core skills, core personas, public schemas | EWAI maintainer |
|
|
32
|
+
| Consultancy or organisation baseline | Reviewed delivery standards, organisation personas, approved Blueprint Packs | Practice or platform owner |
|
|
33
|
+
| Project | Client purpose, users, evidence, constraints, decisions, project personas, delivery records | Client/project owner |
|
|
34
|
+
|
|
35
|
+
Keep client-specific knowledge out of shared packs. Keep mandatory organisation rules in standards rather than hiding them inside personas.
|
|
36
|
+
|
|
37
|
+
## Start every engagement with authority
|
|
38
|
+
|
|
39
|
+
Agree:
|
|
40
|
+
|
|
41
|
+
- who owns the project's SPECS and repository outputs;
|
|
42
|
+
- what the consultancy may inspect, process, retain, and publish;
|
|
43
|
+
- permitted AI hosts and data classifications;
|
|
44
|
+
- approval and delegated-authority boundaries;
|
|
45
|
+
- whether reusable learning may be generalised;
|
|
46
|
+
- how secrets and client-identifying material are excluded;
|
|
47
|
+
- handoff and deletion obligations at engagement end.
|
|
48
|
+
|
|
49
|
+
Do not infer permission to reuse material from access alone.
|
|
50
|
+
|
|
51
|
+
## Use Blueprint Packs as proposals
|
|
52
|
+
|
|
53
|
+
A consultancy Blueprint can provide a high-quality starting point, but the client or project owner must review:
|
|
54
|
+
|
|
55
|
+
- publisher and version;
|
|
56
|
+
- required and optional modules;
|
|
57
|
+
- applicable standards and their consequences;
|
|
58
|
+
- persona templates and source ownership;
|
|
59
|
+
- dependencies and compatibility;
|
|
60
|
+
- governed starter receipts, with separate approval before adding starter files;
|
|
61
|
+
- exact project destinations, receipt, and pin.
|
|
62
|
+
|
|
63
|
+
The material becomes project-owned only after named approval. Record local exceptions and additions in the project, not by silently changing the shared pack for one client.
|
|
64
|
+
|
|
65
|
+
## Create client-specific personas carefully
|
|
66
|
+
|
|
67
|
+
Use project personas for client roles, workflows, vocabulary, and evidence-backed perspectives. Do not place them in a personal or shared organisation library.
|
|
68
|
+
|
|
69
|
+
When extracting reusable learning:
|
|
70
|
+
|
|
71
|
+
1. remove client identity and confidential facts;
|
|
72
|
+
2. separate an observed project fact from a general practice hypothesis;
|
|
73
|
+
3. obtain contractual and accountable approval for reuse;
|
|
74
|
+
4. validate the generalisation with other evidence;
|
|
75
|
+
5. publish it through the shared governance process as a new version.
|
|
76
|
+
|
|
77
|
+
Managed premium personas remain licensed content and must not be republished in client packs or deliverables.
|
|
78
|
+
|
|
79
|
+
## Operate separate runtimes
|
|
80
|
+
|
|
81
|
+
Run check-in against the exact project:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
ewai checkin --project /path/to/client-project --json
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Use the returned dashboard URL for that project. Do not assume a single SQLite database or dashboard represents every engagement. Confirm the project title and root before acting on a handoff or approval.
|
|
88
|
+
|
|
89
|
+
For multi-repository products, use one configured shared SPECS root and explicit repository roles. Do not create competing SPECS trees in each repository.
|
|
90
|
+
|
|
91
|
+
## Offer review as a distinct service
|
|
92
|
+
|
|
93
|
+
A consultancy can separate:
|
|
94
|
+
|
|
95
|
+
- facilitation and intent quality;
|
|
96
|
+
- engineering delivery;
|
|
97
|
+
- standards and security review;
|
|
98
|
+
- independent validation;
|
|
99
|
+
- Manual QA support;
|
|
100
|
+
- production-readiness or governance assessment.
|
|
101
|
+
|
|
102
|
+
State independence honestly. The agent or team that produced work is not automatically an independent reviewer. Define evidence, scope, limitations, and decision authority for every assurance report.
|
|
103
|
+
|
|
104
|
+
## Handoff a usable project
|
|
105
|
+
|
|
106
|
+
At engagement end, provide:
|
|
107
|
+
|
|
108
|
+
- canonical SPECS and repository history;
|
|
109
|
+
- current intent and delivery states;
|
|
110
|
+
- Blueprint receipts, pins, versions, and local changes;
|
|
111
|
+
- project persona ownership and evidence;
|
|
112
|
+
- standards, decisions, exceptions, and open risks;
|
|
113
|
+
- validation and Manual QA evidence;
|
|
114
|
+
- installation and runtime recovery steps;
|
|
115
|
+
- support ownership and unresolved questions.
|
|
116
|
+
|
|
117
|
+
Remove consultancy-only access and runtime material according to the agreed retention process without deleting client-owned evidence.
|
|
118
|
+
|
|
119
|
+
## Multi-project checklist
|
|
120
|
+
|
|
121
|
+
- [ ] Each project has an unambiguous root and SPECS owner.
|
|
122
|
+
- [ ] Client data and personas remain project-local.
|
|
123
|
+
- [ ] Shared packs contain only approved reusable material.
|
|
124
|
+
- [ ] Premium content is not copied or republished.
|
|
125
|
+
- [ ] Validation independence is stated accurately.
|
|
126
|
+
- [ ] Project approval remains with an authorised person.
|
|
127
|
+
- [ ] Runtime and dashboard actions target the correct project.
|
|
128
|
+
- [ ] Handoff preserves durable truth and clarifies retention.
|
|
129
|
+
|
|
130
|
+
## Related guides
|
|
131
|
+
|
|
132
|
+
- [Organisation rollout guide](../organisation-rollout-guide.md)
|
|
133
|
+
- [Internal Blueprint catalogue](../blueprints/internal-blueprint-catalogue.md)
|
|
134
|
+
- [Organisation-specific personas](../personas/organisation-specific-personas.md)
|
|
135
|
+
- [Human approval and assurance](../human-approval-and-assurance-guide.md)
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
# Non-technical team guide
|
|
2
|
+
|
|
3
|
+
Use this guide when you are contributing product, operations, risk, research, policy, or subject-matter knowledge without operating the EWAI command line yourself.
|
|
4
|
+
|
|
5
|
+
## What EWAI needs from you
|
|
6
|
+
|
|
7
|
+
You are not being asked to design the software. You are being asked to help make the intended outcome, real-world context, evidence, constraints, and acceptance decision explicit.
|
|
8
|
+
|
|
9
|
+
Bring:
|
|
10
|
+
|
|
11
|
+
- the problem as people experience it;
|
|
12
|
+
- the outcome that would make the work worthwhile;
|
|
13
|
+
- real users, stakeholders, and decision owners;
|
|
14
|
+
- examples of the current process and its difficult cases;
|
|
15
|
+
- known constraints and things that must not change;
|
|
16
|
+
- evidence for important statements;
|
|
17
|
+
- open questions and disagreements;
|
|
18
|
+
- how you would recognise a useful and safe result.
|
|
19
|
+
|
|
20
|
+
## Where to contribute
|
|
21
|
+
|
|
22
|
+
Work with the project owner in the dashboard running on their computer, either together or in a screen-sharing session. Its local link won't open their project from another computer. The owner can also bring your written answers into the reviewed workflow; check the resulting draft before accepting it. Use **Guided Setup** to help describe a project, [Intent Studio](../guided-intent-workspace-guide.md) to shape one feature, or [Contributions](../guided-phase-evidence-drafting-guide.md) to add evidence to work already under way. Contributions is optional: enable it in **Configuration** first. You can also work through these questions in the EWAI conversation.
|
|
23
|
+
|
|
24
|
+
## Before approving a draft
|
|
25
|
+
|
|
26
|
+
Check that you can:
|
|
27
|
+
|
|
28
|
+
- understand the topic being discussed;
|
|
29
|
+
- ask for unfamiliar terms to be explained;
|
|
30
|
+
- preserve a draft while the conversation develops;
|
|
31
|
+
- see the active personas and why they're involved;
|
|
32
|
+
- distinguish assumptions from evidence;
|
|
33
|
+
- see what files or rules will be created;
|
|
34
|
+
- read the complete Review before approving it;
|
|
35
|
+
- see conflicts with existing project records before anything is written.
|
|
36
|
+
|
|
37
|
+
If you cannot tell what a button will commit, do not approve it.
|
|
38
|
+
|
|
39
|
+
## Understand personas
|
|
40
|
+
|
|
41
|
+
Personas are prompts that bring different professional or user perspectives into the discussion. You may see a Product Owner, operator, accessibility, finance, architecture, or other lens become active as the topic changes.
|
|
42
|
+
|
|
43
|
+
For each active persona, you should be able to see:
|
|
44
|
+
|
|
45
|
+
- its name;
|
|
46
|
+
- whether it is project, premium, personal, or core;
|
|
47
|
+
- why it is relevant now;
|
|
48
|
+
- which concerns it matched.
|
|
49
|
+
|
|
50
|
+
Personas are advisory. They do not represent actual user research, stakeholder consent, legal advice, security certification, or approval. Correct them when their question does not fit the evidence.
|
|
51
|
+
|
|
52
|
+
## Describe evidence, not only conclusions
|
|
53
|
+
|
|
54
|
+
Instead of:
|
|
55
|
+
|
|
56
|
+
> Users need a dashboard.
|
|
57
|
+
|
|
58
|
+
Try:
|
|
59
|
+
|
|
60
|
+
> Three operations managers currently combine two reports each morning to identify delayed cases. They need to see exceptions before the 9:30 review. The dashboard is one proposed solution.
|
|
61
|
+
|
|
62
|
+
This preserves the human need if the implementation changes.
|
|
63
|
+
|
|
64
|
+
## Mark the status of statements
|
|
65
|
+
|
|
66
|
+
Use clear language:
|
|
67
|
+
|
|
68
|
+
- **Observed:** supported by direct evidence.
|
|
69
|
+
- **Proposed:** an option for consideration.
|
|
70
|
+
- **Agreed:** participants align, but formal authority may still be needed.
|
|
71
|
+
- **Decided:** an authorised person made the choice.
|
|
72
|
+
- **Implemented:** observable in the current system.
|
|
73
|
+
- **Unknown:** evidence is missing.
|
|
74
|
+
- **Contradicted:** sources disagree.
|
|
75
|
+
- **Superseded:** a later decision replaced it.
|
|
76
|
+
|
|
77
|
+
Do not let a polished summary turn a proposal into a decision.
|
|
78
|
+
|
|
79
|
+
## Review an organisation baseline
|
|
80
|
+
|
|
81
|
+
An Organisation Blueprint Pack may propose standards and personas that your organisation normally uses. During Review, ask:
|
|
82
|
+
|
|
83
|
+
- Does this baseline actually apply to this project?
|
|
84
|
+
- Which parts are mandatory and which are optional?
|
|
85
|
+
- What will be written into the project?
|
|
86
|
+
- What evidence and approval will be retained?
|
|
87
|
+
- Is any project-specific exception needed?
|
|
88
|
+
|
|
89
|
+
The Blueprint publisher provides the baseline. The project owner remains accountable for adopting it.
|
|
90
|
+
|
|
91
|
+
## Give approval carefully
|
|
92
|
+
|
|
93
|
+
Approval should show:
|
|
94
|
+
|
|
95
|
+
- the complete proposed outcome;
|
|
96
|
+
- exact consequences and destinations;
|
|
97
|
+
- evidence, assumptions, exclusions, and conflicts;
|
|
98
|
+
- the version or digest of reusable content;
|
|
99
|
+
- the named person approving;
|
|
100
|
+
- what future changes would require another review.
|
|
101
|
+
|
|
102
|
+
Selection, preview, and approval are different actions.
|
|
103
|
+
|
|
104
|
+
## Participate in Manual QA
|
|
105
|
+
|
|
106
|
+
You may be the best person to test whether a delivered workflow is useful. Ask for a walkthrough that states the environment, starting point, actions, expected results, and known limitations.
|
|
107
|
+
|
|
108
|
+
Record what actually happened. A failed step is valuable evidence; do not smooth it into a pass. Manual QA acceptance does not itself deploy the change.
|
|
109
|
+
|
|
110
|
+
## Questions you should always be able to ask
|
|
111
|
+
|
|
112
|
+
- Why are we doing this?
|
|
113
|
+
- Who supplied this information?
|
|
114
|
+
- Which persona is active, and why?
|
|
115
|
+
- Is this a fact, proposal, decision, or inference?
|
|
116
|
+
- What changes if I approve?
|
|
117
|
+
- What remains unknown or untested?
|
|
118
|
+
- Who owns the risk or follow-up?
|
|
119
|
+
- Can we reverse this safely?
|
|
120
|
+
|
|
121
|
+
## Related guides
|
|
122
|
+
|
|
123
|
+
- [Product Owner guide](../product-owner-guide.md)
|
|
124
|
+
- [Guided Discovery facilitator guide](../guided-discovery-facilitator-guide.md)
|
|
125
|
+
- [Manual QA and acceptance](../quality/manual-qa-and-acceptance.md)
|
|
126
|
+
- [Worked examples](../examples/worked-examples.md)
|
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
# Archaeology technology and hosting discovery
|
|
2
|
+
|
|
3
|
+
Use this capability during Archaeology to turn repository signals and accountable human answers into a governed view of the technology actually used and where it actually runs.
|
|
4
|
+
|
|
5
|
+
It is designed for inherited systems, poorly documented services, mixed estates and repositories whose deployment files no longer reliably describe production. It supports cloud, on-premises, SaaS, PaaS, IaaS, managed-service and hybrid operating models.
|
|
6
|
+
|
|
7
|
+
Ask EWAI: “During Archaeology, help me establish which technologies this project uses and where it actually runs.” EWAI prepares a briefing from the repository evidence and asks you to confirm the real operating environment. You review misleading signals, supply evidence and identify what remains unknown. Configuration files alone don't establish what's live.
|
|
8
|
+
|
|
9
|
+
The command and JSON reference below is for a technical owner who wants to inspect or record the profile directly. In the guided conversation, EWAI prepares the bundle and answer template with you. If you don't own the hosting information, involve the platform or service owner rather than guessing.
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
<!-- editorial: contents -->
|
|
13
|
+
## On this page
|
|
14
|
+
|
|
15
|
+
- [What it produces](#what-it-produces)
|
|
16
|
+
- [Evidence language](#evidence-language)
|
|
17
|
+
- [Before you begin](#before-you-begin)
|
|
18
|
+
- [Repository topologies](#repository-topologies)
|
|
19
|
+
- [Common signals and pack extensions](#common-signals-and-pack-extensions)
|
|
20
|
+
- [Prepare the owner briefing](#prepare-the-owner-briefing)
|
|
21
|
+
- [Complete the answer template](#complete-the-answer-template)
|
|
22
|
+
- [Record the reviewed profile](#record-the-reviewed-profile)
|
|
23
|
+
- [Check status and handle drift](#check-status-and-handle-drift)
|
|
24
|
+
- [Human review checklist](#human-review-checklist)
|
|
25
|
+
- [Required assurance notice](#required-assurance-notice)
|
|
26
|
+
|
|
27
|
+
## What it produces
|
|
28
|
+
|
|
29
|
+
The workflow adds five files to the selected Archaeology evidence bundle:
|
|
30
|
+
|
|
31
|
+
| File | Purpose |
|
|
32
|
+
| --- | --- |
|
|
33
|
+
| `technology-hosting-brief.json` | Machine-readable Source Map observations, active personas, questions, limitations and preparation digest. |
|
|
34
|
+
| `technology-hosting-brief.md` | Human-readable briefing for the owner conversation. |
|
|
35
|
+
| `technology-hosting-answers.template.json` | Governed input template for owner declarations and confirmations. |
|
|
36
|
+
| `technology-hosting-profile.json` | Attributed reviewed profile preserving observations, answers, contradictions and unresolved questions. |
|
|
37
|
+
| `technology-hosting-profile.md` | Human-readable profile and evidence status. |
|
|
38
|
+
|
|
39
|
+
The workflow does not automatically change the canonical stack strategy, choose a hosting provider, install a technology pack, inspect a live cloud tenant, deploy anything or certify security. A reviewed profile can later support an explicit Archaeology curation decision.
|
|
40
|
+
|
|
41
|
+
## Evidence language
|
|
42
|
+
|
|
43
|
+
The profile deliberately separates three kinds of statement:
|
|
44
|
+
|
|
45
|
+
- `repository-observed`: the Repository Source Map found a file or pack profile that suggests a technology or deployment surface;
|
|
46
|
+
- `owner-declared`: a person supplied an answer but did not mark that individual answer as confirmed;
|
|
47
|
+
- `human-confirmed`: a person explicitly marked that individual answer as confirmed and supplied the relevant evidence references.
|
|
48
|
+
|
|
49
|
+
A reviewer name does not confirm every answer. Confirmation is per technology, hosting field, location and environment.
|
|
50
|
+
|
|
51
|
+
Configuration is never proof of current runtime state. A Terraform file may describe an old experiment. A Salesforce project can be present while a different tenant is live. A CI workflow may no longer be the approved production release route. Keep those signals and record their disposition as `active`, `inactive`, `contradicted` or `uncertain`.
|
|
52
|
+
|
|
53
|
+
## Before you begin
|
|
54
|
+
|
|
55
|
+
This isn't a standalone scan for an empty folder. Accept the optional investigation through [existing-project onboarding](existing-project-onboarding-guide.md#choose-whether-to-run-archaeology), then use the bundle that `ewai-archaeology` prepares. The dated bundle path below is an example: replace it throughout with your actual bundle. Don't create an empty directory and expect it to satisfy the persona-routing prerequisite.
|
|
56
|
+
|
|
57
|
+
1. Complete EWAI initialization and explain the project's purpose.
|
|
58
|
+
2. Accept Archaeology; EWAI prepares or selects its bundle under the configured `SPECS/3.Evidence/archaeology/` root.
|
|
59
|
+
3. Review EWAI's proposed persona perspectives. The agreed selection is recorded in `persona-routing.yaml`.
|
|
60
|
+
4. Put the relevant repositories and extracted platform source in scope, then have EWAI refresh the Repository Source Map. The direct inspection commands are:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
ewai index refresh --project .
|
|
64
|
+
ewai index freshness --project . --json
|
|
65
|
+
ewai archaeology validate-personas \
|
|
66
|
+
SPECS/3.Evidence/archaeology/2026-08-23-system-baseline \
|
|
67
|
+
--project . --json
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Preparation refuses a stale Source Map. It does not silently refresh the index because refreshing and analysing repository evidence is a distinct operation the operator should be able to see.
|
|
71
|
+
|
|
72
|
+
## Repository topologies
|
|
73
|
+
|
|
74
|
+
Technology and hosting discovery uses the repositories already configured in `SPECS/pipeline.yaml`.
|
|
75
|
+
|
|
76
|
+
### Single repository
|
|
77
|
+
|
|
78
|
+
Use one configured application repository. Signals and evidence paths are labelled with that repository name.
|
|
79
|
+
|
|
80
|
+
### Monorepo
|
|
81
|
+
|
|
82
|
+
Configure the monorepo once. The Source Map retains paths for each service, application, infrastructure area and package, so the owner can confirm different runtimes or deployment paths by environment.
|
|
83
|
+
|
|
84
|
+
### Folder containing repository subfolders
|
|
85
|
+
|
|
86
|
+
Configure each repository subfolder as a named repository under the shared SPECS contract. The discovery profile retains the repository name on every observation instead of flattening the estate into one inferred stack.
|
|
87
|
+
|
|
88
|
+
This is particularly important when application, infrastructure, CRM and low-code exports live in separate repositories.
|
|
89
|
+
|
|
90
|
+
## Common signals and pack extensions
|
|
91
|
+
|
|
92
|
+
EWAI recognises common repository signals for:
|
|
93
|
+
|
|
94
|
+
- Node.js, Bun, PHP, Python, Go, Rust, Ruby, JVM and .NET projects;
|
|
95
|
+
- Nuxt, Next.js, Angular, Vite and Prisma configuration;
|
|
96
|
+
- package managers and lockfiles;
|
|
97
|
+
- Docker, Docker Compose, Kubernetes and Helm;
|
|
98
|
+
- Terraform and Azure Bicep;
|
|
99
|
+
- GitHub Actions, GitLab CI/CD, Azure Pipelines and Jenkins;
|
|
100
|
+
- Azure, AWS, Google Cloud, Vercel, Netlify, Fly.io, Render, Railway and Heroku-compatible descriptors;
|
|
101
|
+
- OpenAPI and GraphQL contracts;
|
|
102
|
+
- Microsoft Power Platform and Salesforce project exports.
|
|
103
|
+
|
|
104
|
+
This catalogue is not a closed list. Installed technology, stack, Organisation Blueprint and project Source Map profiles can match additional file types. Those matches appear as pack-provided `source-map-profile` observations carrying the exact profile ID and analyser metadata. EWAI does not turn that identifier into a more specific claim unless the repository or a human supplies the evidence.
|
|
105
|
+
|
|
106
|
+
### Power Platform and Salesforce exports
|
|
107
|
+
|
|
108
|
+
Power Apps and Salesforce can export application or project configuration as archives. Export the material using the platform's supported process, extract the archive into a repository or configured repository subfolder, then refresh the Source Map before preparing discovery.
|
|
109
|
+
|
|
110
|
+
EWAI does not extract ZIP or `.msapp` archives for you. The extracted folder is evidence supplied by the operator; it is not proof of the tenant, environment, region or live release state. See [Power Platform and Salesforce export analysis](platform-export-analysis-guide.md) for the extraction and indexing boundary.
|
|
111
|
+
|
|
112
|
+
## Prepare the owner briefing
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
ewai archaeology prepare-technology-hosting \
|
|
116
|
+
SPECS/3.Evidence/archaeology/2026-08-23-system-baseline \
|
|
117
|
+
--project . --json
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Preparation:
|
|
121
|
+
|
|
122
|
+
- reads only safe Repository Source Map projections;
|
|
123
|
+
- detects built-in and pack-provided signals across every configured repository;
|
|
124
|
+
- loads the approved persona-routing inventory;
|
|
125
|
+
- engages the core Archaeologist and SPECS Knowledge Curator plus relevant confirmed premium, personal and project personas;
|
|
126
|
+
- records exactly which personas are active and why;
|
|
127
|
+
- produces questions covering actual technology, provider, platform/service, locations, environments, deployment model, operating model, data residency, release route, inactive signals, contradictions and unresolved questions.
|
|
128
|
+
|
|
129
|
+
Premium personas improve the lenses available when installed and selected. They are not required for the standard workflow, are never downloaded by this command and cannot replace evidence or accountable confirmation. Project-local personas are valuable for organisation-specific hosting, architecture, operations and release responsibilities.
|
|
130
|
+
|
|
131
|
+
## Complete the answer template
|
|
132
|
+
|
|
133
|
+
In the guided conversation, answer the briefing questions and check EWAI's proposed record. For direct editing, open `technology-hosting-answers.template.json` in the selected bundle and change its answers, not the generated brief. Preserve `schema` and `preparedDigest`. Confirm each answer only if you have the responsibility and evidence to do so; otherwise ask the appropriate owner.
|
|
134
|
+
|
|
135
|
+
For example, find an observation in `technology-hosting-brief.json`, copy its actual `ATH-OBS-…` ID into the related answer's `observationRefs`, and record whether the responsible person confirmed it. `ATH-OBS-1234567890` below is illustrative, not an ID you can submit unchanged. If no observation supports a declaration, don't manufacture one.
|
|
136
|
+
|
|
137
|
+
Each answer supports:
|
|
138
|
+
|
|
139
|
+
```json
|
|
140
|
+
{
|
|
141
|
+
"value": "Microsoft Azure",
|
|
142
|
+
"confirmed": true,
|
|
143
|
+
"observationRefs": ["ATH-OBS-1234567890"],
|
|
144
|
+
"evidence": ["Platform owner confirmation", "Production service inventory"],
|
|
145
|
+
"notes": "Primary production provider"
|
|
146
|
+
}
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
Technology items use `category`, `name` and optional `version` alongside the same confirmation and evidence fields. Environments additionally record provider, platform/service, location, deployment model and operating model.
|
|
150
|
+
|
|
151
|
+
Use `unknown` when the answer is not established. Record the owner of the missing answer in `unresolvedQuestions`. Do not infer a provider, region or data-residency statement from repository configuration.
|
|
152
|
+
|
|
153
|
+
Supported deployment-model values are:
|
|
154
|
+
|
|
155
|
+
`cloud`, `on-premises`, `saas`, `paas`, `iaas`, `managed-service`, `hybrid`, `other`, `unknown`.
|
|
156
|
+
|
|
157
|
+
Supported operating-model values are:
|
|
158
|
+
|
|
159
|
+
`self-managed`, `provider-managed`, `shared`, `third-party-managed`, `hybrid`, `unknown`.
|
|
160
|
+
|
|
161
|
+
Use `observationReviews` to mark each misleading or uncertain repository signal. Preserve contradictions explicitly rather than choosing one source and deleting the other.
|
|
162
|
+
|
|
163
|
+
## Record the reviewed profile
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
ewai archaeology record-technology-hosting \
|
|
167
|
+
SPECS/3.Evidence/archaeology/2026-08-23-system-baseline \
|
|
168
|
+
--input SPECS/3.Evidence/archaeology/2026-08-23-system-baseline/technology-hosting-answers.template.json \
|
|
169
|
+
--reviewed-by "Platform owner" \
|
|
170
|
+
--project . --json
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
The input file must resolve inside the project. Recording validates the preparation digest, every observation reference, deployment and operating vocabularies, reviewer identity and the no-overwrite boundary. The two profile files are written as one recoverable file transaction.
|
|
174
|
+
|
|
175
|
+
After recording, open both `technology-hosting-profile.md` and `.json` in that bundle and check `technology-hosting-status` reports `recorded`. You should see repository observations and owner answers kept separately, including unresolved questions.
|
|
176
|
+
|
|
177
|
+
Recording does not promote the result into canonical strategy. Use the normal Archaeology review and curation workflow when the profile is ready to support proposed SPECS records.
|
|
178
|
+
|
|
179
|
+
## Check status and handle drift
|
|
180
|
+
|
|
181
|
+
```bash
|
|
182
|
+
ewai archaeology technology-hosting-status \
|
|
183
|
+
SPECS/3.Evidence/archaeology/2026-08-23-system-baseline \
|
|
184
|
+
--project . --json
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
Status is one of:
|
|
188
|
+
|
|
189
|
+
- `missing`: no preparation exists;
|
|
190
|
+
- `prepared`: the briefing exists and awaits a recorded profile;
|
|
191
|
+
- `recorded`: the profile matches the preparation and Source Map run;
|
|
192
|
+
- `stale`: the Source Map changed, became stale, or the profile no longer matches its preparation;
|
|
193
|
+
- `invalid`: a stored artefact cannot be read or validated.
|
|
194
|
+
|
|
195
|
+
The status check ignores only this capability's five generated bundle files. Any unrelated indexed file addition, change or deletion makes the result stale.
|
|
196
|
+
|
|
197
|
+
Preparation does not overwrite existing artefacts unless `--force` is explicitly used. A forced re-preparation never overwrites an existing reviewed profile; instead the old profile becomes stale against the new preparation digest. Preserve the previous bundle when historical traceability matters, and normally create a new dated Archaeology bundle for a new baseline.
|
|
198
|
+
|
|
199
|
+
## Human review checklist
|
|
200
|
+
|
|
201
|
+
- Every material runtime, framework, data store, integration and infrastructure component is either recorded or explicitly unknown.
|
|
202
|
+
- Provider, platform/service, location, environment, deployment model and operating model are answered separately.
|
|
203
|
+
- Data storage, processing, backup and replication locations have an accountable confirmation owner.
|
|
204
|
+
- The real release route, approval points and rollback route are recorded.
|
|
205
|
+
- Historical and inactive repository signals retain a disposition and explanation.
|
|
206
|
+
- Contradictions and unresolved questions remain visible.
|
|
207
|
+
- Active personas are visible, relevant and within the approved routing decision.
|
|
208
|
+
- No persona or repository signal is presented as stakeholder acceptance, security approval or business truth.
|
|
209
|
+
|
|
210
|
+
## Required assurance notice
|
|
211
|
+
|
|
212
|
+
Security validation is evidence, not certification or proof that this system is secure. Tools can miss vulnerabilities and produce false positives. A qualified human must review the scope, findings, limitations and residual risk before release.
|