feat: add workflow progress trail to assistant responses#248
Open
XinyuQu wants to merge 1 commit into
Open
Conversation
Adds a new MANDATORY: Workflow Progress Trail rule to core-workflow.md requiring the AI agent to append a one-line breadcrumb at the end of every assistant response during an active AI-DLC session, derived from aidlc-state.md. The trail uses a uniform collapse model at three levels: - Inception phase (7 stages): collapses to "inception (done)" or "inception (pending)" when fully terminal; expands when active. - Per-unit Construction (5 stages per unit): each unit collapses to "Unit X/Y (done)" or "Unit X/Y (pending)" when fully terminal. The active unit AND the active-next unit (first not-fully-done unit) expand so the user sees what's coming up. - Build and Test: single entry, no unit prefix. Construction unit count visibility is gated on Units Generation: - If Units Generation is not yet terminal (pending/in progress), unit count is unknown - render "construction (pending)" placeholder. - If Units Generation is done, read the count from aidlc-state.md. - If Units Generation is skipped, render exactly one Unit 1/1. Status values: (done) | (in progress) | (skipped) | (pending) | (pending, conditional) Adds a trail-emission step to each Inception and Construction stage execution block, plus a Key Principles entry referring back to the MANDATORY rule. Closes awslabs#247
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #247. Adds a new
MANDATORY: Workflow Progress Trailrule tocore-workflow.mdthat requires the AI agent to append a one-line breadcrumb at the end of every assistant response during an active AI-DLC session, derived fromaidlc-docs/aidlc-state.md.The trail surfaces existing state into the chat surface where the user is actually looking — answering "where am I?" and "what's coming up next?" without requiring the user to open
aidlc-state.mdorexecution-plan.mdmid-conversation.Changes
Single file modified:
aidlc-rules/aws-aidlc-rules/core-workflow.md(+70 lines, −0).## MANDATORY: Workflow Progress Trailsection, placed alongside existingMANDATORY:blocks (Content Validation, Question File Format, Custom Welcome Message). Defines:AI-DLC Progress: <stage1> (<status>) -> <stage2> (<status>) -> ...(done),(in progress),(skipped),(pending),(pending, conditional)construction (pending)placeholder rather than fabricating a unit count.aidlc-state.mdyet, or workflow complete).MANDATORY: Append workflow progress trail per ...) to the execution block of each Inception stage (7) and each Construction stage (5 per-unit + Build and Test = 6). 13 total — one for every stage that ends with a user-visible response.Workflow Progress Trailentry to the## Key Principleslist, mirroring the placement ofPlan-Level Checkbox Enforcementadded in PR fix: update execution-plan.md status on stage completion #69.No changes to
aidlc-state.mdschema,execution-plan.mdformat, the extension framework, or any rule-detail file underaidlc-rules/aws-aidlc-rule-details/.User experience
Before: During a long AI-DLC workflow, the user has no in-chat indicator of which stage is current, which were skipped, or how many remain. The information lives in
aidlc-state.md,audit.md, andexecution-plan.md(Mermaid + checklist), but accessing it requires switching context and opening files mid-conversation.After: Every assistant response in an active AI-DLC session ends with a single line like:
The user can see at a glance: Inception is done, Unit 1 is finished, Unit 2 is mid-flight on functional design, Unit 3 hasn't started, and Build and Test is the final step. No file-switching required.
Token cost: ~1 line per assistant turn (~30 tokens).
aidlc-state.mdis already read as part of session continuity, so no new file-read overhead.Checklist
Test Plan
1. markdownlint (full repo, 58 files):
2. Reachability check — trail-emission step present in every stage's execution block:
(7 Inception + 5 per-unit Construction + 1 Build and Test = 13.)
3. Sandbox test environment — installed the modified rules into an isolated test directory at the path the rule's
MANDATORY: Rule Details Loadingblock resolves for non-Kiro/non-AmazonQ tools (.aidlc-rules/+.aidlc-rule-details/):4. Synthetic state-file scenarios — exercised the rule's rendering logic against four
aidlc-state.mdshapes covering the full workflow span:construction (pending)placeholder (no fake unit count)Unit 1/1expanded with current stateEach scenario produces output that matches one of the three worked examples embedded in the rule, byte-for-byte (verified by
diff).5. Length comparison — full-expand vs. uniform-collapse model on the brownfield mid-Construction scenario:
The collapse model keeps long workflows scannable while preserving full visibility of the active and active-next phase/unit.
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.