eric/promptkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Plan effective requirement inspection implementation

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-08 17:28:04 +00:00
parent 7827ca043b
commit 71f6683fda
4 changed files with 715 additions and 362 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/roadmap/inspection.md
View File

@@ -1,9 +1,10 @@
# Effective Prompt Requirement Inspection
Status: Proposed feature scope; implementation has not started. The
recommendations under Open Decisions need agreement before implementation
planning. This document owns the target end state and migration scope, not a
staged implementation sequence.
Status: Implementation planned; the feature is not implemented. The
[implementation plan](implementation.md) owns the ordered migration steps and
uses the recommended scope below. Open Decisions still records the alternative
scope choices for confirmation. This document owns the target end state and
migration scope.
## Purpose
@@ -45,7 +46,7 @@ context-sensitive requirement discovery.
## Target Public Operation
Add a separate read-only engine operation, provisionally
Add a separate read-only engine operation, planned as
`Engine.InspectRequirements`, with a dedicated request and result. Preserve
`InspectPrompt`, `InspectProfile`, preparation, and execution contracts.
@@ -67,7 +68,7 @@ about a later engine or later execution with changed variables.
## Result And Requirement Meanings
Expose public Go values with documented classifications and predictable ordering.
Exact symbol and field spelling belongs in the subsequent implementation plan
Exact symbol and field spelling belongs in the implementation plan
and GoDoc. No Promptkit JSON wire schema is part of this feature.
The result contains:
@@ -198,7 +199,7 @@ When implementation lands, update GoDoc, the consumer guide, relevant format
cross-references, and the internal component/source documents. Describe the
analysis boundary and examples of complete, unsatisfied, and incomplete results
in their canonical owners. Release notes explain the new capability; they do
not own its contract. A separate staged plan will own implementation sequencing.
not own its contract. The implementation plan owns implementation sequencing.
## Acceptance Outcomes
@@ -230,8 +231,8 @@ direct caller-variable access, ordinary `if`/`with` control flow, and simple
variable-derived names and comparisons where their values are determinable.
Account for template variable scope and short-circuit behavior for supported
expressions. Additional constructs can be supported where straightforward;
otherwise report incompleteness when they affect requirement discovery. Specify
the exact supported expression families before writing the implementation plan.
otherwise report incompleteness when they affect requirement discovery. The
implementation plan specifies the exact expression families for this baseline.
This covers the representative consumer needs while keeping completeness
honest and avoiding a second general-purpose interpreter.