docs: CLI specification trifecta and engineering workflow#142
Merged
Alan-Jowett merged 1 commit intomicrosoft:mainfrom Mar 30, 2026
Merged
docs: CLI specification trifecta and engineering workflow#142Alan-Jowett merged 1 commit intomicrosoft:mainfrom
Alan-Jowett merged 1 commit intomicrosoft:mainfrom
Conversation
Extract structured specifications from the existing CLI code using PromptKit's own spec-extraction-workflow: - requirements.md: 82 functional/non-functional requirements (REQ-CLI-NNN) covering assembly, manifest resolution, launch, content bundling, and npm distribution - design.md: Module architecture, data flow, interface contracts, key design decisions, and 11 known gaps (including redundancy with bootstrap.md identified in the CLI analysis) - validation.md: 62 test cases (TC-CLI-NNN) with traceability matrix mapping each test to its requirement - engineering-workflow.md: Assembled evolve prompt (software-architect persona, 10 protocols verbatim) for future CLI changes The spec trifecta was extracted by executing PromptKit's spec-extraction-workflow against the CLI source. The engineering workflow was assembled programmatically by the CLI's own assemble command, validating that assemble.js produces correct verbatim output. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a structured “spec trifecta” (requirements, design, validation) for the PromptKit CLI plus a verbatim assembled engineering-workflow prompt, establishing a semantic baseline to guide upcoming CLI refactoring.
Changes:
- Added CLI requirements specification with REQ-CLI-* items, constraints, and assumptions.
- Added CLI design specification describing module architecture, data flow, and known gaps.
- Added CLI validation plan with TC-CLI-* cases and a requirements traceability matrix.
- Added a verbatim assembled
engineering-workflowprompt artifact produced by the CLI assembly engine.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| cli/specs/requirements.md | Introduces structured, traceable functional/non-functional requirements for the CLI. |
| cli/specs/design.md | Documents current CLI architecture, module responsibilities, data flows, and identified gaps. |
| cli/specs/validation.md | Defines test strategy + test cases and maps requirements to planned validation coverage. |
| cli/specs/engineering-workflow.md | Checks in a verbatim assembled workflow prompt to validate assembly output and enable propagation workflows. |
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
Adds structured specifications for the PromptKit CLI, extracted from existing code using PromptKit's own
spec-extraction-workflow. These specs establish a semantic baseline for the CLI ahead of planned refactoring.Files
cli/specs/requirements.mdcli/specs/design.mdcli/specs/validation.mdcli/specs/engineering-workflow.mdHow these were produced
Spec trifecta (requirements, design, validation): Extracted by executing PromptKit's
spec-extraction-workflowagainst the CLI source code. The LLM agent read all 4 source files, the package.json, bootstrap.md, and the CLI analysis identifying redundancies.Engineering workflow: Assembled programmatically by the CLI's own
assemblecommand (node -ewithassemble()), validating thatassemble.jsproduces correct verbatim output. The CLI assembled 10 protocols + persona + taxonomy + template in under 1 second.Key findings from the spec extraction
format: nulltemplates or parameterized personasContext
These specs will serve as the baseline for CLI refactoring work. The engineering-workflow prompt is ready to use for propagating changes through the spec → design → validation → implementation chain.