-
Notifications
You must be signed in to change notification settings - Fork 5
Add missing Non-Goals and Quality Checklist sections to 8 templates #29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Alan-Jowett
merged 2 commits into
microsoft:main
from
Alan-Jowett:fix/issue-20-missing-template-sections
Mar 19, 2026
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| <!-- SPDX-License-Identifier: MIT --> | ||
| <!-- Copyright (c) PromptKit Contributors --> | ||
|
|
||
| --- | ||
| name: implementation-plan | ||
| type: format | ||
| description: > | ||
| Output format for implementation and refactoring plans. Defines | ||
| section structure for task breakdown, dependency ordering, risk | ||
| assessment, and verification strategy. | ||
| produces: implementation-plan | ||
| --- | ||
|
|
||
| # Format: Implementation Plan | ||
|
|
||
| The output MUST be a structured implementation plan with the following | ||
| sections in this exact order. Do not omit sections — if a section has no | ||
| content, state "None identified" with a brief justification. | ||
|
|
||
| ## Document Structure | ||
|
|
||
| ```markdown | ||
| # <Plan Title> — Implementation Plan | ||
|
|
||
| ## 1. Overview | ||
| <1–3 paragraphs: what is being implemented or refactored, why, | ||
| and what the end state looks like. Include the goal, scope, and | ||
| any driving requirements or design documents.> | ||
|
|
||
| ## 2. Current State | ||
| <Description of the starting point: | ||
| - What exists today (code, infrastructure, processes) | ||
| - What works and what doesn't | ||
| - Key assumptions about the current state | ||
|
|
||
| For greenfield projects, state "Greenfield — no existing implementation." | ||
| For refactoring, provide a behavioral summary of the current code.> | ||
|
|
||
| ## 3. Prerequisites | ||
| <What must be true before work begins: | ||
| - Required documents (requirements, design) | ||
| - Environment setup | ||
| - Dependencies on other teams or systems | ||
| - Decisions that must be made first> | ||
|
|
||
| ## 4. Plan | ||
|
|
||
| ### Phase <N>: <Phase Name> | ||
|
|
||
| #### TASK-<NNN>: <Task Title> | ||
| - **Description**: <what to implement or change> | ||
| - **Requirements**: <REQ-IDs addressed, if available> | ||
| - **Dependencies**: <TASK-IDs that must complete first, or "None"> | ||
| - **Acceptance Criteria**: <how to verify completion> | ||
| - **Complexity**: Small / Medium / Large | ||
| - **Risks**: <what could go wrong with this task> | ||
| - **Verification**: <how to confirm correctness after this task> | ||
| - **Rollback**: <how to undo this change if needed> | ||
|
|
||
| <Repeat for each task. Group tasks into phases representing | ||
| logical milestones or deliverables.> | ||
|
|
||
| ## 5. Dependency Graph | ||
| <Text-based diagram (Mermaid, ASCII, or structured list) showing | ||
| task dependencies and the critical path. Identify which sequence | ||
| of dependent tasks determines the minimum time to completion.> | ||
|
|
||
| ## 6. Risk Assessment | ||
| | Risk ID | Description | Likelihood | Impact | Mitigation | | ||
| |---------|-------------|-----------|--------|------------| | ||
| | RISK-001 | ... | High/Med/Low | High/Med/Low | ... | | ||
|
|
||
| ## 7. Verification Strategy | ||
| <How to confirm the plan is complete and correct: | ||
| - What tests should pass at each phase boundary | ||
| - Integration or end-to-end verification approach | ||
| - How to validate the final state matches the target> | ||
|
|
||
| ## 8. Open Questions | ||
| <Decisions that need to be made before or during implementation. | ||
| For each: what is unknown, why it matters, and who can resolve it.> | ||
|
|
||
| ## 9. Revision History | ||
| <Table: | Version | Date | Author | Changes |> | ||
| ``` | ||
|
|
||
| ## Formatting Rules | ||
|
|
||
| - Tasks MUST be ordered by dependency, not by perceived importance. | ||
| - Every task MUST have acceptance criteria (how to know it is done). | ||
| - Every task MUST have a complexity estimate (Small / Medium / Large). | ||
| - The critical path MUST be identified in the dependency graph. | ||
| - Tasks MUST use stable identifiers: `TASK-<NNN>` with sequential numbering. | ||
| - Cross-references between tasks use the task ID | ||
| (e.g., "depends on TASK-003"). | ||
| - Phases represent logical milestones — each phase should be | ||
| independently demonstrable or deployable where possible. |
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
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
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
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
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
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.