Skip to content

Commit 17fa58d

Browse files
fix: Improve formatting and clarity in prompt documentation
1 parent ec576d6 commit 17fa58d

File tree

3 files changed

+30
-17
lines changed

3 files changed

+30
-17
lines changed

.github/copilot-instructions.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,27 @@
33
Auto-generated from all feature plans. Last updated: 2025-10-01
44

55
## Active Technologies
6+
67
- PowerShell 7.4+ (GitHub Actions composite actions) + PSModule/GitHub-Script@v1, PSModule/Install-PSModuleHelpers@v1 (001-building-on-this)
78

89
## Project Structure
9-
```
10+
11+
```plaintext
1012
src/
1113
tests/
1214
```
1315

1416
## Commands
15-
# Add commands for PowerShell 7.4+ (GitHub Actions composite actions)
17+
18+
Add commands for PowerShell 7.4+ (GitHub Actions composite actions)
1619

1720
## Code Style
21+
1822
PowerShell 7.4+ (GitHub Actions composite actions): Follow standard conventions
1923

2024
## Recent Changes
25+
2126
- 001-building-on-this: Added PowerShell 7.4+ (GitHub Actions composite actions) + PSModule/GitHub-Script@v1, PSModule/Install-PSModuleHelpers@v1
2227

2328
<!-- MANUAL ADDITIONS START -->
24-
<!-- MANUAL ADDITIONS END -->
29+
<!-- MANUAL ADDITIONS END -->

.github/prompts/analyze.prompt.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,19 +67,22 @@ Execution steps:
6767

6868
6. Produce a Markdown report (no file writes) with sections:
6969

70+
```markdown
7071
### Specification Analysis Report
7172

7273
| ID | Category | Severity | Location(s) | Summary | Recommendation |
7374
|----|----------|----------|-------------|---------|----------------|
7475
| A1 | Duplication | HIGH | spec.md:L120-134 | Two similar requirements ... | Merge phrasing; keep clearer version |
75-
7676
(Add one row per finding; generate stable IDs prefixed by category initial.)
77+
```
7778

7879
Additional subsections:
7980
- Coverage Summary Table:
8081

81-
| Requirement Key | Has Task? | Task IDs | Notes |
82-
|-----------------|-----------|----------|-------|
82+
```markdown
83+
| Requirement Key | Has Task? | Task IDs | Notes |
84+
|-----------------|-----------|----------|-------|
85+
```
8386

8487
- Constitution Alignment Issues (if any)
8588
- Unmapped Tasks (if any)

.github/prompts/clarify.prompt.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
description: Identify underspecified areas in the current feature spec by asking up to 5 highly targeted clarification questions and encoding answers back into the spec.
33
---
44

5+
# Clarify
6+
57
The user input to you can be provided directly by the agent or as a command argument - you **MUST** consider it before proceeding with the prompt (if not empty).
68

79
User input:
@@ -79,24 +81,26 @@ Execution steps:
7981
3. Generate (internally) a prioritized queue of candidate clarification questions (maximum 5). Do NOT output them all at once. Apply these constraints:
8082
- Maximum of 5 total questions across the whole session.
8183
- Each question must be answerable with EITHER:
82-
* A short multiple‑choice selection (2–5 distinct, mutually exclusive options), OR
83-
* A one-word / short‑phrase answer (explicitly constrain: "Answer in <=5 words").
84-
- Only include questions whose answers materially impact architecture, data modeling, task decomposition, test design, UX behavior, operational readiness, or compliance validation.
85-
- Ensure category coverage balance: attempt to cover the highest impact unresolved categories first; avoid asking two low-impact questions when a single high-impact area (e.g., security posture) is unresolved.
86-
- Exclude questions already answered, trivial stylistic preferences, or plan-level execution details (unless blocking correctness).
87-
- Favor clarifications that reduce downstream rework risk or prevent misaligned acceptance tests.
88-
- If more than 5 categories remain unresolved, select the top 5 by (Impact * Uncertainty) heuristic.
84+
* A short multiple‑choice selection (2–5 distinct, mutually exclusive options), OR
85+
* A one-word / short‑phrase answer (explicitly constrain: "Answer in <=5 words").
86+
- Only include questions whose answers materially impact architecture, data modeling, task decomposition, test design, UX behavior, operational readiness, or compliance validation.
87+
- Ensure category coverage balance: attempt to cover the highest impact unresolved categories first; avoid asking two low-impact questions when a single high-impact area (e.g., security posture) is unresolved.
88+
- Exclude questions already answered, trivial stylistic preferences, or plan-level execution details (unless blocking correctness).
89+
- Favor clarifications that reduce downstream rework risk or prevent misaligned acceptance tests.
90+
- If more than 5 categories remain unresolved, select the top 5 by (Impact * Uncertainty) heuristic.
8991

9092
4. Sequential questioning loop (interactive):
9193
- Present EXACTLY ONE question at a time.
9294
- For multiple‑choice questions render options as a Markdown table:
9395

96+
```markdown
9497
| Option | Description |
9598
|--------|-------------|
9699
| A | <Option A description> |
97100
| B | <Option B description> |
98-
| C | <Option C description> | (add D/E as needed up to 5)
99-
| Short | Provide a different short answer (<=5 words) | (Include only if free-form alternative is appropriate)
101+
| C | <Option C description> (add D/E as needed up to 5) |
102+
| Short | Provide a different short answer (<=5 words) (Include only if free-form alternative is appropriate) |
103+
```
100104

101105
- For short‑answer style (no meaningful discrete options), output a single line after the question: `Format: Short answer (<=5 words)`.
102106
- After the user answers:
@@ -147,12 +151,13 @@ Execution steps:
147151
- Suggested next command.
148152

149153
Behavior rules:
154+
150155
- If no meaningful ambiguities found (or all potential questions would be low-impact), respond: "No critical ambiguities detected worth formal clarification." and suggest proceeding.
151156
- If spec file missing, instruct user to run `/specify` first (do not create a new spec here).
152157
- Never exceed 5 total asked questions (clarification retries for a single question do not count as new questions).
153158
- Avoid speculative tech stack questions unless the absence blocks functional clarity.
154159
- Respect user early termination signals ("stop", "done", "proceed").
155-
- If no questions asked due to full coverage, output a compact coverage summary (all categories Clear) then suggest advancing.
156-
- If quota reached with unresolved high-impact categories remaining, explicitly flag them under Deferred with rationale.
160+
- If no questions asked due to full coverage, output a compact coverage summary (all categories Clear) then suggest advancing.
161+
- If quota reached with unresolved high-impact categories remaining, explicitly flag them under Deferred with rationale.
157162

158163
Context for prioritization: $ARGUMENTS

0 commit comments

Comments
 (0)