@tianhai/pi-workflow-kit 0.17.1 → 0.18.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -37
- package/docs/developer-usage-guide.md +32 -14
- package/docs/lessons.md +18 -0
- package/docs/oversight-model.md +11 -5
- package/docs/plans/completed/2026-06-09-code-review-fixes-implementation.md +74 -0
- package/docs/plans/completed/2026-06-09-code-review-fixes-progress.md +14 -0
- package/docs/plans/completed/2026-06-09-incremental-workflow-and-rename-design.md +186 -0
- package/docs/plans/completed/2026-06-09-incremental-workflow-and-rename-implementation.md +675 -0
- package/docs/plans/completed/2026-06-09-incremental-workflow-and-rename-progress.md +18 -0
- package/docs/plans/completed/2026-06-09-incremental-workflow-and-rename-verification-report.md +81 -0
- package/docs/plans/completed/2026-06-09-verification-fixes-implementation.md +69 -0
- package/docs/plans/completed/2026-06-09-verification-fixes-progress.md +14 -0
- package/docs/workflow-phases.md +19 -13
- package/extensions/workflow-guard.ts +10 -9
- package/package.json +2 -1
- package/skills/{brainstorming → pwk-brainstorming}/SKILL.md +17 -6
- package/skills/{design-review → pwk-design-review}/SKILL.md +11 -9
- package/skills/{diagnose → pwk-diagnose}/SKILL.md +1 -1
- package/skills/{executing-tasks → pwk-executing-tasks}/SKILL.md +46 -16
- package/skills/{finalizing → pwk-finalizing}/SKILL.md +9 -2
- package/skills/{verify → pwk-verify}/SKILL.md +3 -3
- package/skills/{writing-plans → pwk-writing-plans}/SKILL.md +21 -6
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
name: writing-plans
|
|
2
|
+
name: pwk-writing-plans
|
|
3
3
|
description: "Use this to break a design into an implementation plan with bite-sized TDD tasks. Works with or without a prior brainstorm. Use this skill when the user says 'let's plan', 'break this down', 'write a plan', 'create tasks', or after a brainstorm session when they want to move to implementation. Also use when the user has a clear idea and wants to jump straight to a structured plan."
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -11,7 +11,9 @@ You may only create or edit files under `docs/plans/`. Do not modify source code
|
|
|
11
11
|
|
|
12
12
|
1. **Check for a design doc** — look for `docs/plans/*-design.md`. If one exists, use it as the basis for the plan. If the design doc is incomplete, fill gaps by asking the human. If no design doc exists, ask the user to describe what they want to build and read relevant code. **Read `docs/lessons.md`** if it exists — incorporate known patterns into the task breakdown (e.g., if a lesson says "always run lint before commit," include that in relevant task instructions).
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
If the design doc has a `## Features` table, read it to identify the next feature with status `⬜ pending`. Mark that feature as `🔄 planned` by editing the design doc. This plan will cover only that one feature. If the design doc has no Features table, plan the entire design as before.
|
|
15
|
+
|
|
16
|
+
Then evaluate whether the feature — whether from the design doc or from the user's description and codebase exploration — involves any of the following:
|
|
15
17
|
|
|
16
18
|
- Database schema changes or migrations
|
|
17
19
|
- Authentication or authorization logic
|
|
@@ -20,10 +22,21 @@ You may only create or edit files under `docs/plans/`. Do not modify source code
|
|
|
20
22
|
- File uploads or large data flows
|
|
21
23
|
- Redis, caching, or message queues
|
|
22
24
|
|
|
23
|
-
If any apply
|
|
25
|
+
If any apply, prompt the user: "This feature involves [list what you found] but hasn't been reviewed for production risks. Run `/skill:pwk-design-review` first, or type 'proceed' to skip."
|
|
24
26
|
|
|
25
27
|
If the design doc explicitly notes "Simple change — no design review needed", skip this check.
|
|
26
|
-
2. **Write the implementation plan** — break the
|
|
28
|
+
2. **Write the implementation plan** — break the feature into tasks. Save to `docs/plans/YYYY-MM-DD-<topic>-<feature-name>-implementation.md` (derive `<feature-name>` from the feature's name in the table, slugified). If the design doc has no Features table, use `docs/plans/YYYY-MM-DD-<topic>-implementation.md`. Include metadata at the top of the plan doc so the executor can find the design doc and feature row:
|
|
29
|
+
|
|
30
|
+
```markdown
|
|
31
|
+
# Implementation Plan: <feature name>
|
|
32
|
+
|
|
33
|
+
## Overview
|
|
34
|
+
|
|
35
|
+
Design: docs/plans/YYYY-MM-DD-<topic>-design.md
|
|
36
|
+
Feature: <feature name> (row N in Features table)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
If the design is too large for ~15 tasks for a single feature, flag this to the human and ask whether to reduce scope or proceed with the full plan.
|
|
27
40
|
3. **Present the plan** — show the complete plan to the human. Wait for approval before suggesting execution.
|
|
28
41
|
|
|
29
42
|
Before presenting, run the **Plan Acceptance Audit**:
|
|
@@ -31,7 +44,7 @@ You may only create or edit files under `docs/plans/`. Do not modify source code
|
|
|
31
44
|
- **Task Sizing**: Is any single task too large or covering multiple complex behaviors? If so, split it.
|
|
32
45
|
- **QA Coverage**: Does every task have both a Happy Path and at least one Edge Case in its Acceptance Criteria?
|
|
33
46
|
- **Checkpoint Alignment**: Are `checkpoint: test` and `checkpoint: done` gates placed on the most critical or risky tasks?
|
|
34
|
-
- **Risk Enforcement**: If
|
|
47
|
+
- **Risk Enforcement**: If this plan doc's Architectural Review section flagged any hazards as `[TRIGGERED]`, verify the corresponding tasks have `checkpoint: done` and a `Hazard Mitigation Verification` section.
|
|
35
48
|
|
|
36
49
|
If any check fails, fix the plan before presenting.
|
|
37
50
|
|
|
@@ -289,7 +302,9 @@ Use judgment when assigning checkpoints. Prefer `checkpoint: test` for new featu
|
|
|
289
302
|
|
|
290
303
|
## After the plan
|
|
291
304
|
|
|
292
|
-
Ask: "Ready to execute? Run `/skill:executing-tasks`"
|
|
305
|
+
Ask: "Ready to execute? Run `/skill:pwk-executing-tasks`"
|
|
306
|
+
|
|
307
|
+
> After executing this feature, the executor will check for more `⬜ pending` features and suggest planning the next one.
|
|
293
308
|
|
|
294
309
|
## Behavioral Guidelines
|
|
295
310
|
|