@thebackstoryis/engineering-with-ai 0.3.0 → 0.3.1-beta.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.
package/Docs/README.md CHANGED
@@ -30,6 +30,8 @@ If you have a persona licence, [set it up before the analysis](operations/premiu
30
30
 
31
31
  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).
32
32
 
33
+ To try the beta communication guidance, read [concise answers and guided decisions](context-management-and-token-efficiency.md#concise-answers-and-guided-decisions), including examples and installation instructions.
34
+
33
35
  ## Make the dashboard work for you
34
36
 
35
37
  [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.
@@ -6,6 +6,48 @@ You normally don't prepare context manually: the relevant EWAI skill does that f
6
6
 
7
7
  Context preparation doesn't approve Build or Manual QA, accept risk, certify quality, deploy or release.
8
8
 
9
+ ## Concise answers and guided decisions
10
+
11
+ **Availability:** This guidance is included in `0.3.1-beta.0`. Follow [beta installation](operations/installation-updating-and-entitlements.md#try-the-beta-channel), then initialise the project or run its normal EWAI check-in to refresh the managed instructions in `AGENTS.md` and `CLAUDE.md`. Start a fresh host conversation after the refresh. Project-authored guidance outside the managed block is preserved. npm `0.3.0` does not include these new instructions. Tool-result compaction remains planned, and no incremental token or cost saving has been measured for this update.
12
+
13
+ ### Get a useful short answer
14
+
15
+ Describe the result you need, for example:
16
+
17
+ > “Give me the result and next action concisely. Keep the evidence, exact commands, important risks and anything you couldn't verify.”
18
+
19
+ The guidance prioritises correctness and usefulness, then brevity. Expect the result or recommendation first, with less repetition and routine narration. Required status, warnings and approval steps still appear. A short answer should retain prerequisites, meaningful action order, failures and uncertainty; it should not replace working instructions with shorthand.
20
+
21
+ When you need more detail, ask for it:
22
+
23
+ > “Expand the migration steps, including prerequisites, verification and recovery.”
24
+
25
+ Detailed requests still need complete answers. If a concise answer leaves you unable to act safely or understand the evidence, ask for the missing detail before acting.
26
+
27
+ ### Make an informed decision
28
+
29
+ A decision request should explain the action, consequences, material options and tradeoffs, then give a recommendation with its reason. A suggested response can help you express your choice; it does not record approval on your behalf.
30
+
31
+ You can ask:
32
+
33
+ > “Explain what I need to decide, recommend an option with its reason, and suggest a reply. Include what happens next and any uncertainty.”
34
+
35
+ When the evidence cannot support a choice, expect a recommendation for the next evidence-gathering step. Build approval, Manual QA and release decisions still need their own explicit authority; see [who approves what](human-approval-and-assurance-guide.md).
36
+
37
+ ### Refine an unclear request
38
+
39
+ The guidance leads with a recommended interpretation and explains assumptions that affect the outcome. It asks one focused question when missing information materially changes the scope or next action, with guidance and a recommended response.
40
+
41
+ For example, if you say “Make onboarding simpler”, an illustrative response is:
42
+
43
+ > “I recommend reviewing the existing onboarding journey first to identify where people get stuck. I'm assuming you want the journey assessed before changing the implementation. Should we start with that review? Suggested response: ‘Yes, review the journey first and recommend changes.’”
44
+
45
+ Correct the interpretation when it misses your intent. Work already authorised and independent of your answer can continue; a proposed interpretation or suggested reply does not expand that authority.
46
+
47
+ ### Understand savings claims
48
+
49
+ Shorter replies aim to reduce output tokens. The context preparation described below addresses input tokens. Neither a shorter example nor the packaged context benchmark establishes whole-session cost savings. Assess equivalent work using actual provider usage where available, including retries and clarification rounds, alongside correctness and how well the answer supports your decision. Unknown usage remains unknown.
50
+
9
51
  ## Inspect the evidence sent to the model
10
52
 
11
53
  Open **Configuration**, enable **AI context diagnostics** and save, then open that view in the sidebar. See [dashboard configuration](operations/dashboard-configuration.md) if you need help finding it.
@@ -20,6 +20,7 @@ Choose the section that matches your job. The optional team tools aren't prerequ
20
20
  - [Facilitate project Discovery](guided-discovery-facilitator-guide.md)
21
21
  - [Create or revise an intent in Intent Studio](guided-intent-workspace-guide.md)
22
22
  - [Choose work with the Companion](context-aware-delivery-companion-user-guide.md)
23
+ - [Get concise answers and useful decision guidance (beta)](context-management-and-token-efficiency.md#concise-answers-and-guided-decisions)
23
24
  - [Delegate an exact pool of intents with guarded autonomy](autonomous-intent-delivery.md)
24
25
  - [Contribute information to work in progress](guided-phase-evidence-drafting-guide.md)
25
26
  - [Review evidence from meeting notes or transcripts](meeting-evidence-user-guide.md)
@@ -46,6 +46,23 @@ npx --yes @thebackstoryis/engineering-with-ai@latest
46
46
 
47
47
  This asks npm to obtain and run the package. It doesn't create a standing global installation.
48
48
 
49
+ ## Try the beta channel
50
+
51
+ The beta channel is an opt-in prerelease. Version `0.3.1-beta.0` adds [concise answers and guided decisions](../context-management-and-token-efficiency.md#concise-answers-and-guided-decisions); production remains `0.3.0`.
52
+
53
+ For one project:
54
+
55
+ ```bash
56
+ npm install --save-dev @thebackstoryis/engineering-with-ai@beta
57
+ npx ewai
58
+ ```
59
+
60
+ To pin this specific beta instead of following the beta channel, replace `@beta` with `@0.3.1-beta.0`. For a global beta installation, use `npm install --global @thebackstoryis/engineering-with-ai@beta`, then start EWAI in your project folder.
61
+
62
+ Initialisation or normal check-in refreshes the EWAI-managed block in `AGENTS.md` and `CLAUDE.md`. Guidance outside that block is preserved. In an existing project, you can refresh explicitly with `npx ewai checkin --project . --json` for a project dependency, or `ewai checkin --project . --json` for a global installation. Start a fresh host conversation after refreshing so it reads the new instructions. Review changes to your project's package, lockfile and instruction files before committing them.
63
+
64
+ Beta check-in offers updates from the beta channel. To return to production deliberately, install `@latest` using the same project-local or global scope, then run that version's check-in and start a fresh conversation. Review the instruction changes and use [dashboard recovery](troubleshooting-and-recovery.md#dashboard-will-not-start) if an older runtime is still running. Returning to production does not undo work already performed in your application.
65
+
49
66
  ## Start your project
50
67
 
51
68
  Open your project folder in the host and start EWAI. Agree where its SPECS folder should live before initialising it. For existing code, EWAI offers Archaeology to reconstruct missing project knowledge; you can accept or decline it.
package/README.md CHANGED
@@ -2,6 +2,21 @@
2
2
 
3
3
  Engineering With AI (EWAI) helps you plan, build and review software with an AI assistant. It gives the assistant a shared record of the project, a delivery workflow and checks against your engineering standards. You keep control of the decisions and approve implementation before it starts.
4
4
 
5
+ ## Beta: concise answers and useful decision guidance
6
+
7
+ Version `0.3.1-beta.0` adds communication guidance that prioritises correctness and usefulness, then brevity. Decision requests include action details, supporting guidance, a recommendation with its reason and a suggested response when useful. Query refinement leads with a recommended interpretation and explains consequential assumptions.
8
+
9
+ To try this beta in one project:
10
+
11
+ ```bash
12
+ npm install --save-dev @thebackstoryis/engineering-with-ai@beta
13
+ npx ewai
14
+ ```
15
+
16
+ Initialisation or the next check-in refreshes EWAI's managed instructions in `AGENTS.md` and `CLAUDE.md`, preserving project-authored guidance outside that block. Start a fresh host conversation after the refresh. See [the user guide](Docs/context-management-and-token-efficiency.md#concise-answers-and-guided-decisions) for examples and [beta installation and recovery](Docs/operations/installation-updating-and-entitlements.md#try-the-beta-channel) for other installation choices.
17
+
18
+ This beta adds communication instructions and documentation. Tool-result compaction remains planned, and incremental token or cost savings have not been measured. Mandatory workflow and human approvals still apply. The production npm channel remains on `0.3.0`.
19
+
5
20
  ## EWAI can now pick up the next ready piece of work
6
21
 
7
22
  If you’ve prepared several work items, you can choose which ones EWAI is allowed to take on. EWAI checks what’s ready, uses the priorities you’ve recorded to pick the next item, and starts its delivery workflow. Once you’ve separately approved the Build, it can run the approved build tasks, their tests and a fresh review.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thebackstoryis/engineering-with-ai",
3
- "version": "0.3.0",
3
+ "version": "0.3.1-beta.0",
4
4
  "description": "A human-centred, AI-augmented engineering pipeline",
5
5
  "license": "SEE LICENSE IN LICENSE",
6
6
  "author": "The Backstory Is",
package/src/project.mjs CHANGED
@@ -90,6 +90,20 @@ const checkinInstructionFiles = ['AGENTS.md', 'CLAUDE.md'];
90
90
  const checkinInstruction = `<!-- EWAI-CHECKIN:START -->
91
91
  ## EWAI conversation check-in
92
92
 
93
+ ### Concise, useful output
94
+
95
+ Prioritise correctness, fidelity and usefulness, then brevity. Resist verbosity: remove repetition, filler, restated requests and routine tool narration. Lead with the result or recommendation, using plain language and enough action detail to make it usable.
96
+
97
+ Preserve exact commands and identifiers, prerequisites, meaningful step order, failure evidence, uncertainty and human authority. Report only verification actually performed. Follow mandatory check-in, status, consent and phase protocols. Expand when a shorter answer would hide a consequential fact or when detail is requested; do not impose arbitrary word limits.
98
+
99
+ For a decision ask, include what needs deciding, relevant action details and consequences, supporting guidance, material options and tradeoffs, a recommendation with its reason, and a clear ask. Provide a suggested response when it helps the person act. If evidence is insufficient, recommend the next evidence-gathering step. Recommendations, defaults and suggested replies never constitute approval.
100
+
101
+ ### Query refinement
102
+
103
+ Lead with the recommended interpretation or refined request, explaining consequential assumptions. Ask one focused question only when missing information materially changes the scope, outcome or next action; include supporting guidance and a recommended response with its reason. Keep uncertainty visible, preserve the user's intent and continue independent authorised work. After clarification, confirm the refined request briefly and act within its authority boundaries.
104
+
105
+ ### Check-in and workflow
106
+
93
107
  Keep the complete workflow, but present it cleanly: four routine status lines plus the returned menu at a decision point. Preserve warnings, blockers and unknown checks with short reasons; detailed diagnostics are on request. Progress is one sentence of at most 24 words per meaningful checkpoint. Do not narrate commands, file reads, JSON parsing or internal reasoning, and do not repeat the menu during a selected action. Never shorten briefing, purpose alignment, consent, standards or approval gates to meet an output limit. Use the guarded dashboard password form by default for licence setup; a private terminal prompt is an alternative only when a genuine interactive terminal is available. Never emulate hidden terminal entry through chat.
94
108
 
95
109
  When \`.ewai-pipeline/project.json\` exists, perform one EWAI check-in at the start of each new agent conversation before substantive project work. That locator identifies the configured SPECS root; do not assume it is \`./SPECS\`. Claude may receive its check-in JSON from the managed SessionStart hook; interpret that result instead of running it twice. Otherwise run \`ewai checkin --project . --json\`. This starts or reuses the project-local pipeline dashboard and refreshes its SQLite projection. Always interpret and report the EWAI version/update status, premium entitlement and installed-library status, dashboard URL, state-integrity result, mandatory standards status, configured external validators, and any configured-versus-installed CLI mismatch. Show unknown checks with their reason rather than omitting them.