docs: explain how to provide input documents to the agent (#250) - #445
Open
valter-silva-au wants to merge 1 commit into
Open
docs: explain how to provide input documents to the agent (#250)#445valter-silva-au wants to merge 1 commit into
valter-silva-au wants to merge 1 commit into
Conversation
The writing-inputs guides describe what a Vision Document and Technical Environment Document are and how they feed each AI-DLC stage, but never state the mechanical step of how to hand a document to the agent or where to place it. Users asking "where do I put a vision document?" got non-definitive answers (awslabs#250). Add a "How to Provide ... to the Agent" section near the top of both vision-document-guide.md and inputs-quickstart.md: place the document anywhere, reference it in the initial request (e.g. "read ./vision.md and start the AI-DLC workflow"), or paste it into chat — no enforced folder convention.
valter-silva-au
requested review from
a team,
Kalindi-Dev,
harmjeff,
leandrodamascena,
raj-jain-aws,
scottschreckengaust and
spraja08
June 27, 2026 06:09
Author
|
Heads-up on CI: the Security Scanners workflow (gitleaks/grype) shows red, but it's failing on |
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 #250.
The
writing-inputsguides explain what a Vision Document and Technical Environment Document are and how they feed each AI-DLC stage, but never tell the user the mechanical step of how to hand a document to the agent or where to place it. As reported in #250, a user who asked "where do I put a vision document?" got a confused, non-definitive answer.This adds the missing instruction, matching the fix @leandrodamascena outlined in the issue thread.
Changes
Add a short "How to Provide … to the Agent" section near the top of both:
docs/writing-inputs/vision-document-guide.mddocs/writing-inputs/inputs-quickstart.mdThe section states the intended flow: place the document anywhere in your project and reference it in your initial request (e.g.
read ./vision.md and start the AI-DLC workflow), or paste its contents into chat — no enforced folder convention.Docs-only and additive; no rules, code, or behavioral change. (The issue also floated a tweak to
requirements-analysis.md, but its Step 4 already instructs the agent to use "existing requirements documents (search workspace if mentioned)" and "pasted content or file references", so the genuine remaining gap was the user-facing docs.)User experience
Checklist
Test Plan
markdownlint-cli2(the repo's CI lint,.markdownlint-cli2.yaml) passes on both files with 0 errors.A)-style consecutive lines introduced.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.