docs: add working-with-aidlc interaction guide and writing-inputs documents#121
docs: add working-with-aidlc interaction guide and writing-inputs documents#121harmjeff wants to merge 12 commits intoawslabs:mainfrom
Conversation
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
docs/writing-inputs/example-minimal-tech-env-scientific-calculator-api.md
Show resolved
Hide resolved
scottschreckengaust
left a comment
There was a problem hiding this comment.
Consider placing files under docs
Move working-with-aidlc.md to docs/WORKING-WITH-AIDLC.md and consolidate all writing-inputs guides under docs/writing-inputs/. Prefix all example files with 'example-' for clarity and consistency. Update all internal references to reflect new locations. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
All @scottschreckengaust requests are completed |
Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>
Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>
Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>
Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>
Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>
Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>
Kalindi-Dev
left a comment
There was a problem hiding this comment.
@harmjeff
This is nitpicky and can be added to subsequent releases:
-
WORKING-WITH-AIDLC.md:118 — "If your tool offers a 'compact context' prompt mid-workflow, always decline it" is strong advice that may become outdated as context management in AI tools evolves. Consider softening to something like "compaction mid-workflow is generally less reliable than a clean
reset." -
WORKING-WITH-AIDLC.md:555 — "This flow takes a few extra minutes compared to directly editing a file." Contains an implicit time estimate. Minor, but could be rephrased as "This flow takes extra steps compared to directly editing a file."
Looks good to me otherwise.
Summary
working-with-aidlc.md— a practical guide covering interaction patterns, tips, and examples drawn from real workshop experience, covering the full workflow from Inception through Constructionwriting-inputs/folder with guides and templates for preparing Vision and Technical Environment documents before starting a projectREADME.mdAdditional Resources table with a reference toworking-with-aidlc.mdTest plan
README.mdpointing toworking-with-aidlc.mdresolve correctlyworking-with-aidlc.md(e.g. towriting-inputs/files) resolve correctlywriting-inputs/inputs-quickstart.mdfor greenfield and brownfield quick-start pathswriting-inputs/vision-document-guide.mdandwriting-inputs/technical-environment-guide.mdfor completenessBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.