pi-feature-dev 1.6.0 → 1.8.0
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 +6 -2
- package/package.json +1 -1
- package/skills/plan-review/SKILL.md +176 -190
- package/skills/plan-review/agents/openai.yaml +2 -2
- package/skills/ste/README.md +13 -0
- package/skills/ste/SKILL.md +33 -1
- package/skills/ste/references/checklist.md +95 -0
- package/skills/ste/references/use-cases.md +95 -0
package/README.md
CHANGED
|
@@ -73,6 +73,7 @@ versions came from:
|
|
|
73
73
|
- [anthropics/claude-code feature-dev plugin](https://github.com/anthropics/claude-code/tree/main/plugins/feature-dev)
|
|
74
74
|
- [mattpocock/skills batch-grill-me and domain-modeling skills](https://github.com/mattpocock/skills)
|
|
75
75
|
- [danyuchn/asd-ste100-skill](https://github.com/danyuchn/asd-ste100-skill)
|
|
76
|
+
- [AminBlg/SimpleEnglish](https://github.com/AminBlg/SimpleEnglish/tree/main/skills/simple-english)
|
|
76
77
|
|
|
77
78
|
## Usage
|
|
78
79
|
|
|
@@ -139,8 +140,9 @@ The `ste` skill selects one of two modes:
|
|
|
139
140
|
- **STE clarity** transfers the same clarity discipline to other technical
|
|
140
141
|
text without claiming formal ASD-STE100 compliance.
|
|
141
142
|
|
|
142
|
-
The skill loads its detailed writing rules
|
|
143
|
-
they are relevant to the request.
|
|
143
|
+
The skill loads its detailed writing rules, review checklist, text-type
|
|
144
|
+
patterns, and before/after examples only when they are relevant to the request.
|
|
145
|
+
Standard provenance, design references, and source links stay in
|
|
144
146
|
`skills/ste/README.md`, outside the agent's writing context.
|
|
145
147
|
|
|
146
148
|
## Package contents
|
|
@@ -172,6 +174,8 @@ pi-feature-dev/
|
|
|
172
174
|
├── agents/openai.yaml
|
|
173
175
|
├── references/
|
|
174
176
|
│ ├── before-after.md
|
|
177
|
+
│ ├── checklist.md
|
|
178
|
+
│ ├── use-cases.md
|
|
175
179
|
│ └── writing-rules.md
|
|
176
180
|
├── README.md
|
|
177
181
|
└── SKILL.md
|
package/package.json
CHANGED
|
@@ -1,201 +1,187 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: plan-review
|
|
3
|
-
description: Review implementation plans before execution. Use after a plan is created or when the user asks to validate a plan for correctness, scope, over-engineering, missing tests,
|
|
3
|
+
description: Review implementation plans against the actual repository before execution, combining plan-quality checks with an evidence-backed technical pre-mortem and a PASS / REVISE / BLOCK verdict. Use after a plan is created or when the user asks to validate a plan for correctness, scope, over-engineering, missing tests, project-convention fit, blast radius, rollback, migration risk, contract risk, authorization risk, production-config risk, or what could break. Review plan files such as docs/plans/*.md or a user-provided plan path. Prefer isolated read-only review when the host and policy support it.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
+
# Plan Review
|
|
6
7
|
|
|
7
|
-
|
|
8
|
+
Review the plan before implementation. First verify that it solves the stated
|
|
9
|
+
problem with the smallest repository-aligned approach. Then assume the plan has
|
|
10
|
+
already shipped and failed; work backward from repository evidence to explain
|
|
11
|
+
why.
|
|
8
12
|
|
|
9
|
-
**
|
|
13
|
+
**Remain read-only. Analyze and report; never implement or edit the plan.**
|
|
10
14
|
|
|
11
|
-
**
|
|
15
|
+
**Prefix every finding with `[plan-review]` and identify the affected plan
|
|
16
|
+
section or task.**
|
|
12
17
|
|
|
13
|
-
##
|
|
18
|
+
## Isolate the Review
|
|
14
19
|
|
|
15
|
-
Prefer an isolated reviewer when the host agent and active policy support
|
|
20
|
+
Prefer an isolated reviewer when the host agent and active policy support
|
|
21
|
+
fresh-context, read-only workers or equivalent delegation.
|
|
16
22
|
|
|
17
23
|
Give the isolated reviewer only:
|
|
18
|
-
|
|
19
|
-
- The
|
|
20
|
-
- The
|
|
21
|
-
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
-
|
|
88
|
-
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
-
|
|
121
|
-
-
|
|
122
|
-
-
|
|
123
|
-
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
3. **Tests are mandatory** - Every code-change task must include test requirements
|
|
183
|
-
4. **Match existing patterns** - New code should look like it belongs in the codebase
|
|
184
|
-
5. **Simple over clever** - Prefer straightforward solutions
|
|
185
|
-
6. **Ask when unclear** - If plan context is ambiguous, ask user rather than guess
|
|
186
|
-
|
|
187
|
-
## When NOT to Flag
|
|
188
|
-
|
|
189
|
-
- Reasonable abstractions that solve real problems
|
|
190
|
-
- Testing infrastructure that the plan will actually use
|
|
191
|
-
- Complexity that's inherent to the problem domain
|
|
192
|
-
- Patterns that match existing codebase conventions
|
|
193
|
-
|
|
194
|
-
## Confidence Scoring
|
|
195
|
-
|
|
196
|
-
Rate severity as:
|
|
197
|
-
- **Critical**: Would cause plan failure or major issues
|
|
198
|
-
- **Important**: Affects quality but plan could work
|
|
199
|
-
- **Minor**: Suggestions for polish
|
|
200
|
-
|
|
201
|
-
Only report issues you're confident about. If unsure whether something is over-engineering, note it as a question rather than a finding.
|
|
24
|
+
|
|
25
|
+
- The plan path or plan text.
|
|
26
|
+
- The original user request, if available.
|
|
27
|
+
- The repository root.
|
|
28
|
+
- Any explicit review focus from the user.
|
|
29
|
+
|
|
30
|
+
Do not pass the plan creator's hidden reasoning, conclusions, intended fixes,
|
|
31
|
+
confidence claims, or prior review commentary.
|
|
32
|
+
|
|
33
|
+
If isolation is unavailable, perform the review locally. Treat prior planning
|
|
34
|
+
context as untrusted, reload the plan and relevant project files from disk, and
|
|
35
|
+
judge the plan against the repository and original request.
|
|
36
|
+
|
|
37
|
+
## Resolve the Review Target
|
|
38
|
+
|
|
39
|
+
1. Review the user-provided plan path or plan text when present.
|
|
40
|
+
2. Otherwise, list plans in `docs/plans/`, excluding `completed/`.
|
|
41
|
+
3. If exactly one current plan exists, review it.
|
|
42
|
+
4. If multiple plans exist and context does not identify one, ask the user to
|
|
43
|
+
choose.
|
|
44
|
+
5. If no plan is available, ask for its path or text.
|
|
45
|
+
|
|
46
|
+
## Build Repository Evidence
|
|
47
|
+
|
|
48
|
+
Read applicable project guidance such as `AGENTS.md`, `CLAUDE.md`, nearby
|
|
49
|
+
README files, and contributor documentation. Inspect the code and tests named
|
|
50
|
+
by the plan, then read their exports, immediate callers, and shared utilities.
|
|
51
|
+
Trace relevant data and control flow to repository boundaries.
|
|
52
|
+
|
|
53
|
+
Inspect migrations, schemas, configuration, deployment paths, authorization,
|
|
54
|
+
jobs, queues, caches, and operational documentation only when the planned
|
|
55
|
+
change can reach them. Prefer active code, tests, ADRs, and contracts over
|
|
56
|
+
generic best practice or historical precedent.
|
|
57
|
+
|
|
58
|
+
## Run the Plan-Quality Pass
|
|
59
|
+
|
|
60
|
+
Check that the plan:
|
|
61
|
+
|
|
62
|
+
- States the actual problem, requested outcome, assumptions, non-goals, and
|
|
63
|
+
acceptance criteria.
|
|
64
|
+
- Records the relevant repository context, affected files, systems, and
|
|
65
|
+
workflows, the selected approach, and why it fits active patterns.
|
|
66
|
+
- Proposes a solution that can produce the outcome without missing steps and
|
|
67
|
+
handles relevant domain edge cases and failure paths.
|
|
68
|
+
- Keeps scope neither too broad nor too narrow: include all work required for
|
|
69
|
+
the outcome and exclude unrelated work.
|
|
70
|
+
- Follows all user and repository instructions, current code patterns, naming
|
|
71
|
+
and comment conventions, and preferred existing libraries.
|
|
72
|
+
- Produces readable, maintainable code through appropriate decomposition; do
|
|
73
|
+
not accept cleverness or layering that the problem does not require.
|
|
74
|
+
- Orders dependencies correctly and divides work into concrete, atomic tasks
|
|
75
|
+
with descriptive names and exact files, symbols, and commands.
|
|
76
|
+
- Gives every code-change task separate test work that protects the intended
|
|
77
|
+
rule, including exact test-file locations and relevant success, error, and
|
|
78
|
+
edge cases.
|
|
79
|
+
- Requires relevant tests to pass before the next task, names exact verification
|
|
80
|
+
commands, and records any external, credentialed, manual, or
|
|
81
|
+
environment-dependent step needed for completion.
|
|
82
|
+
|
|
83
|
+
If `plan-make` created the plan, also check its self-contained plan contract.
|
|
84
|
+
Do not require its exact headings when the same information is clear elsewhere.
|
|
85
|
+
|
|
86
|
+
### Reject Over-Engineering and YAGNI Violations
|
|
87
|
+
|
|
88
|
+
Actively look for:
|
|
89
|
+
|
|
90
|
+
- Unnecessary abstractions or interfaces without a current use.
|
|
91
|
+
- Premature generalization and flexibility added "just in case."
|
|
92
|
+
- Pattern abuse where direct code meets the requirement.
|
|
93
|
+
- Excessive layers, indirection, configuration, or extension points.
|
|
94
|
+
- New dependencies or custom utilities that duplicate repository or standard
|
|
95
|
+
capabilities.
|
|
96
|
+
- Features and infrastructure not required by the requested outcome.
|
|
97
|
+
|
|
98
|
+
Require the simpler alternative when it satisfies the current requirement and
|
|
99
|
+
repository constraints. Do not flag complexity inherent to the domain.
|
|
100
|
+
|
|
101
|
+
Resolve uncertainty from repository evidence first. If a user decision could
|
|
102
|
+
change behavior, scope, approach, or verdict, ask instead of guessing. If the
|
|
103
|
+
review must conclude before the user answers, report the decision as `UNKNOWN`
|
|
104
|
+
and return `BLOCK` rather than inventing an assumption.
|
|
105
|
+
|
|
106
|
+
## Run the Technical Pre-Mortem Pass
|
|
107
|
+
|
|
108
|
+
Assume the planned change was merged, deployed, and failed. Investigate the
|
|
109
|
+
failure as an accomplished fact instead of asking abstractly what might go
|
|
110
|
+
wrong.
|
|
111
|
+
|
|
112
|
+
Reconstruct the blast radius:
|
|
113
|
+
|
|
114
|
+
1. Identify what the plan changes.
|
|
115
|
+
2. Trace what depends on each changed surface.
|
|
116
|
+
3. Trace what state, identity, contract, configuration, or infrastructure those
|
|
117
|
+
dependents share.
|
|
118
|
+
|
|
119
|
+
Use these as relevance-gated leads, not a coverage quota. Skip what the change
|
|
120
|
+
cannot touch, and follow evidence beyond this list:
|
|
121
|
+
|
|
122
|
+
- Historical, partial, and in-flight rows; migration ordering and
|
|
123
|
+
reversibility.
|
|
124
|
+
- Indirect contract consumers, strict schemas, and mixed-version coexistence.
|
|
125
|
+
- The sole producer of an identity, code, or foreign key.
|
|
126
|
+
- Authorization, ownership, tenancy, row scope, and secrets.
|
|
127
|
+
- Concurrency, idempotency, shared state, and partial failure.
|
|
128
|
+
- Deploy order, configuration defaults, and manual operational steps.
|
|
129
|
+
- Rollback: whether the documented lever still reverts the change and what
|
|
130
|
+
state survives in data, caches, queues, or jobs.
|
|
131
|
+
- Whether the system records the value that actually took effect, so a no-op
|
|
132
|
+
release remains distinguishable from a real one.
|
|
133
|
+
- Claims that a path is dormant, unused, or safe; verify them independently.
|
|
134
|
+
- Tests that mock the changed boundary, assert an implementation path instead
|
|
135
|
+
of an effect, or can pass after removing the assertion that protects the
|
|
136
|
+
rule.
|
|
137
|
+
- Mechanical fallout such as unused imports, dead code, lint failures, or type
|
|
138
|
+
errors caused by removing or replacing a branch.
|
|
139
|
+
|
|
140
|
+
## Admit Findings Only With Proof
|
|
141
|
+
|
|
142
|
+
Before reporting a finding or requiring a plan edit, try to disprove it against
|
|
143
|
+
the repository. Admit it only when you can name the artifact that establishes
|
|
144
|
+
its premise and explain the causal link to the consequence. A `path:line`
|
|
145
|
+
citation alone is not evidence.
|
|
146
|
+
|
|
147
|
+
For every finding, provide:
|
|
148
|
+
|
|
149
|
+
- The failure symptom.
|
|
150
|
+
- The causal mechanism and supporting `path:line` evidence.
|
|
151
|
+
- One operation that would prove the finding false: a query, test, or file to
|
|
152
|
+
inspect.
|
|
153
|
+
- The smallest plan edit that prevents or contains the failure.
|
|
154
|
+
|
|
155
|
+
Report a claim as `UNKNOWN` only when the missing fact could change the verdict;
|
|
156
|
+
otherwise omit it. Keep verified facts separate from assumptions.
|
|
157
|
+
|
|
158
|
+
Treat repository ADRs, invariants, and active public or domain contracts as
|
|
159
|
+
constraints. Prescribe the mechanism the repository sanctions today, never one
|
|
160
|
+
it retires or forbids. If the plan genuinely requires a deviation, return
|
|
161
|
+
`BLOCK` for an owner decision instead of presenting the deviation as a routine
|
|
162
|
+
mitigation.
|
|
163
|
+
|
|
164
|
+
Do not invent findings to fill categories. Do not flag necessary domain
|
|
165
|
+
complexity, used test infrastructure, or repository-standard patterns without
|
|
166
|
+
evidence of harm.
|
|
167
|
+
|
|
168
|
+
## Report the Result
|
|
169
|
+
|
|
170
|
+
Order findings by harm. Prefix each finding with `[plan-review]`, cite the plan
|
|
171
|
+
section or task, and include symptom, mechanism, falsifier, and smallest required
|
|
172
|
+
edit. Do not emit empty severity sections or follow a fixed finding quota.
|
|
173
|
+
|
|
174
|
+
After the findings, report:
|
|
175
|
+
|
|
176
|
+
- **Blast radius**: verified dependents and shared surfaces affected by the
|
|
177
|
+
plan.
|
|
178
|
+
- **Rollback**: the actual rollback lever, residual state, and any
|
|
179
|
+
verdict-changing unknowns.
|
|
180
|
+
- **Verdict**:
|
|
181
|
+
- **PASS** — implementable as written.
|
|
182
|
+
- **REVISE** — implementable only after the named plan edits; state those
|
|
183
|
+
edits as requirements, not advice.
|
|
184
|
+
- **BLOCK** — do not implement until an unmitigated blocking risk, forbidden
|
|
185
|
+
mechanism, or owner decision is resolved.
|
|
186
|
+
|
|
187
|
+
Report and stop. Do not implement.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Plan Review"
|
|
3
|
-
short_description: "
|
|
4
|
-
default_prompt: "Use $plan-review to review this implementation plan
|
|
3
|
+
short_description: "Evidence-backed plan review and pre-mortem"
|
|
4
|
+
default_prompt: "Use $plan-review to review this implementation plan against the repository, run a technical pre-mortem, and return a PASS / REVISE / BLOCK verdict."
|
package/skills/ste/README.md
CHANGED
|
@@ -9,6 +9,9 @@ This project skill applies ASD-STE100 Simplified Technical English principles to
|
|
|
9
9
|
|
|
10
10
|
The skill is Markdown-only and has no runtime or tool dependency.
|
|
11
11
|
|
|
12
|
+
Its agent-facing instructions stay compact. Detailed writing rules, review checklists, text-type
|
|
13
|
+
patterns, and examples are separate references that the agent loads only when a task needs them.
|
|
14
|
+
|
|
12
15
|
## Standard Baseline
|
|
13
16
|
|
|
14
17
|
The skill uses ASD-STE100 Simplified Technical English, Issue 9, dated 2025-01-15.
|
|
@@ -32,3 +35,13 @@ not as a compliant or certified document.
|
|
|
32
35
|
|
|
33
36
|
ASD owns the copyright and trademarks for ASD-STE100. Do not copy the official dictionary or
|
|
34
37
|
extended passages without permission.
|
|
38
|
+
|
|
39
|
+
## Design References
|
|
40
|
+
|
|
41
|
+
The skill design also incorporates ideas from these open-source implementations:
|
|
42
|
+
|
|
43
|
+
- [danyuchn/asd-ste100-skill](https://github.com/danyuchn/asd-ste100-skill)
|
|
44
|
+
- [AminBlg/SimpleEnglish](https://github.com/AminBlg/SimpleEnglish/tree/main/skills/simple-english)
|
|
45
|
+
|
|
46
|
+
This project keeps its own conservative verification boundary. External checklists and examples
|
|
47
|
+
do not establish formal STE compliance.
|
package/skills/ste/SKILL.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: ste
|
|
3
|
-
description: Draft, rewrite, and review clear, unambiguous English with ASD-STE100 Simplified Technical English Issue 9 principles. Use for
|
|
3
|
+
description: Draft, rewrite, and review clear, unambiguous English with ASD-STE100 Simplified Technical English Issue 9 principles. Use for READMEs, runbooks, procedures, safety instructions, API and tool documentation, prompts, agent instructions, UI and error messages, status and incident reports, release notes, support text, translation-ready content, terminology normalization, controlled English, and STE compliance reviews. Also use when asked to simplify or de-slop English, help non-native readers, or prepare text for translation. Support strict verification only with the official dictionary and project glossary; otherwise report an STE-aligned or STE-style result.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# STE
|
|
@@ -29,6 +29,10 @@ status reports, translation-ready text, and other technical or operational Engli
|
|
|
29
29
|
|
|
30
30
|
- Read [references/writing-rules.md](references/writing-rules.md) for strict STE work, compliance
|
|
31
31
|
reviews, safety text, word-count decisions, or rule details.
|
|
32
|
+
- Read [references/checklist.md](references/checklist.md) for strict reviews, audits, high-risk
|
|
33
|
+
text, or long documents. Use its quick check or full check as the task requires.
|
|
34
|
+
- Read [references/use-cases.md](references/use-cases.md) when the text type needs a clear
|
|
35
|
+
information order or a reusable structure.
|
|
32
36
|
- Read [references/before-after.md](references/before-after.md) when rewriting dense text,
|
|
33
37
|
explaining changes, or producing a comparison.
|
|
34
38
|
- Read all user-supplied glossaries, safety policies, style guides, and regulatory directives that
|
|
@@ -51,6 +55,18 @@ Do not invent missing facts. Do not remove precision only to meet a length targe
|
|
|
51
55
|
Keep a qualitative modifier such as `carefully` when it affects task intent. Flag it when the
|
|
52
56
|
project requires a measurable criterion, but do not invent that criterion.
|
|
53
57
|
|
|
58
|
+
## Protect Untouchable Text
|
|
59
|
+
|
|
60
|
+
Unless the user explicitly asks to edit the exact literal, do not change:
|
|
61
|
+
|
|
62
|
+
- Code blocks, inline code, identifiers, placeholders, and data values.
|
|
63
|
+
- CLI commands, flags, file paths, URLs, and protocol elements.
|
|
64
|
+
- Product, API, configuration, database, and schema names.
|
|
65
|
+
- Quoted UI labels, error strings, log text, and externally defined messages.
|
|
66
|
+
|
|
67
|
+
Rewrite the sentence around an untouchable literal when necessary. Never silently normalize the
|
|
68
|
+
literal itself.
|
|
69
|
+
|
|
54
70
|
## Apply the Core Discipline
|
|
55
71
|
|
|
56
72
|
| Area | Apply |
|
|
@@ -81,6 +97,18 @@ project requires a measurable criterion, but do not invent that criterion.
|
|
|
81
97
|
|
|
82
98
|
If the input is already clear and meets the applicable rules, say so. Do not force a rewrite.
|
|
83
99
|
|
|
100
|
+
## Self-check Before Delivery
|
|
101
|
+
|
|
102
|
+
Always confirm that:
|
|
103
|
+
|
|
104
|
+
1. The revision preserves every fact, condition, limit, unit, exception, sequence, and
|
|
105
|
+
responsibility.
|
|
106
|
+
2. Untouchable text is unchanged unless the user requested that exact change.
|
|
107
|
+
3. Each procedural sentence has one independent action unless actions occur at the same time.
|
|
108
|
+
4. Actors, referents, conditions, results, and terminology are unambiguous and consistent.
|
|
109
|
+
5. The result uses the correct mode, verification status, and unresolved checks.
|
|
110
|
+
6. Each cited rule number was verified directly against the authoritative standard.
|
|
111
|
+
|
|
84
112
|
## Choose the Output
|
|
85
113
|
|
|
86
114
|
For a direct drafting or rewriting request:
|
|
@@ -103,6 +131,10 @@ After the table, give the complete revised text. Group unresolved items as:
|
|
|
103
131
|
|
|
104
132
|
Use the user's requested format when it conflicts with these defaults.
|
|
105
133
|
|
|
134
|
+
Name the applicable rule area in explanations. Cite an Issue 9 rule number only after you verify
|
|
135
|
+
that number in the official standard or an authoritative copy supplied by the user. Do not infer
|
|
136
|
+
rule numbers from memory, summaries, or another skill.
|
|
137
|
+
|
|
106
138
|
## State Verification Honestly
|
|
107
139
|
|
|
108
140
|
Use one of these statuses only when a status is useful:
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# STE Review Checklist
|
|
2
|
+
|
|
3
|
+
Use this checklist as an operational review aid. It is not a replacement for the official
|
|
4
|
+
ASD-STE100 standard or dictionary. A search result identifies text to inspect; it does not prove
|
|
5
|
+
that the text violates a rule.
|
|
6
|
+
|
|
7
|
+
## Quick Check
|
|
8
|
+
|
|
9
|
+
Use this check for a general clarity rewrite:
|
|
10
|
+
|
|
11
|
+
- Compare the source and revision. Preserve facts, conditions, limits, units, exceptions,
|
|
12
|
+
sequence, and responsibility.
|
|
13
|
+
- Confirm that code, identifiers, commands, paths, labels, quoted messages, and other protected
|
|
14
|
+
literals did not change.
|
|
15
|
+
- Use explicit actors, referents, conditions, actions, and results.
|
|
16
|
+
- Put a prerequisite condition before the action that depends on it.
|
|
17
|
+
- Keep one independent action in each procedural sentence unless actions occur at the same time.
|
|
18
|
+
- Use one term for one concept and one wording for one repeated action.
|
|
19
|
+
- Separate observed facts, possible causes, and recovery actions.
|
|
20
|
+
- Report unresolved technical, lexical, safety, or regulatory questions.
|
|
21
|
+
|
|
22
|
+
## Full Check
|
|
23
|
+
|
|
24
|
+
Use this check for strict STE work, compliance reviews, safety text, high-risk content, or long
|
|
25
|
+
documents.
|
|
26
|
+
|
|
27
|
+
### 1. Meaning and Scope
|
|
28
|
+
|
|
29
|
+
- Make an inventory of actions, facts, conditions, negation, quantities, units, limits,
|
|
30
|
+
exceptions, warnings, consequences, and cross-references.
|
|
31
|
+
- Confirm the scope of each modifier and logical connector.
|
|
32
|
+
- Confirm that the revision does not add a cause, risk level, requirement, or technical fact.
|
|
33
|
+
|
|
34
|
+
### 2. Vocabulary and Terminology
|
|
35
|
+
|
|
36
|
+
- Verify each general word against the official Issue 9 dictionary.
|
|
37
|
+
- Verify its approved meaning, part of speech, form, and use.
|
|
38
|
+
- Verify each technical noun and technical verb against the applicable category and project
|
|
39
|
+
glossary.
|
|
40
|
+
- Record unverified terms instead of assuming that they are approved.
|
|
41
|
+
- Check abbreviations, spelling, and alternate names for the same concept.
|
|
42
|
+
|
|
43
|
+
### 3. Grammar and Sentences
|
|
44
|
+
|
|
45
|
+
- Check active voice, permitted verb forms, articles, complete constructions, and explicit
|
|
46
|
+
referents.
|
|
47
|
+
- Inspect each `-ing` form, passive construction, modal verb, and multi-word verb in context.
|
|
48
|
+
- Split overloaded sentences and complex alternatives.
|
|
49
|
+
- Confirm that connecting words show the intended logical relation.
|
|
50
|
+
|
|
51
|
+
### 4. Procedures and Descriptions
|
|
52
|
+
|
|
53
|
+
- Classify each section as a procedure, description, safety instruction, or mixed content.
|
|
54
|
+
- For procedures, use imperative commands and put prerequisite conditions first.
|
|
55
|
+
- For descriptions, present information gradually and keep one topic in each paragraph.
|
|
56
|
+
- Put complex sequences and alternatives in vertical lists.
|
|
57
|
+
|
|
58
|
+
### 5. Length and Mechanics
|
|
59
|
+
|
|
60
|
+
- Apply the Issue 9 word-count method.
|
|
61
|
+
- Check the 20-word procedure limit and the 25-word description limit.
|
|
62
|
+
- Check the six-sentence description-paragraph limit.
|
|
63
|
+
- Inspect semicolons, parentheses, hyphens, and long multi-word nouns.
|
|
64
|
+
|
|
65
|
+
### 6. Safety
|
|
66
|
+
|
|
67
|
+
- Preserve the governing safety label and required wording.
|
|
68
|
+
- Start with the required command or condition.
|
|
69
|
+
- State only the known risk or possible result.
|
|
70
|
+
- Confirm that simplification did not weaken the safety intent.
|
|
71
|
+
|
|
72
|
+
### 7. Delivery
|
|
73
|
+
|
|
74
|
+
- Apply project, regulatory, and customer directives before general STE preferences.
|
|
75
|
+
- Use the correct verification status.
|
|
76
|
+
- List unresolved checks.
|
|
77
|
+
- Cite a rule number only after direct verification in an authoritative copy of Issue 9.
|
|
78
|
+
|
|
79
|
+
## Search Cues
|
|
80
|
+
|
|
81
|
+
Search for these features during a large review:
|
|
82
|
+
|
|
83
|
+
- Contractions such as `can't`, `don't`, `'re`, and `'ve`.
|
|
84
|
+
- Semicolons.
|
|
85
|
+
- `-ing` forms.
|
|
86
|
+
- Perfect or continuous auxiliary constructions.
|
|
87
|
+
- Forms of `be` followed by a past participle.
|
|
88
|
+
- Modal verbs such as `should`, `would`, `may`, `might`, and `could`.
|
|
89
|
+
- Vague referents such as `it`, `this`, `that`, `they`, and `which`.
|
|
90
|
+
- `and` or `then` between commands.
|
|
91
|
+
- Different nouns or verbs that might name the same concept or action.
|
|
92
|
+
- Sentences and description paragraphs above their applicable limits.
|
|
93
|
+
|
|
94
|
+
Inspect each match in context. Do not treat every `if`, `when`, `-ing` form, passive construction,
|
|
95
|
+
modal verb, or repeated connector as an automatic violation.
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# Text-Type Patterns
|
|
2
|
+
|
|
3
|
+
Use these patterns when the source does not already have a required structure. They describe
|
|
4
|
+
useful information order, not additional ASD-STE100 rules. Preserve the user's requested format
|
|
5
|
+
and all protected literals.
|
|
6
|
+
|
|
7
|
+
## Procedure or Runbook
|
|
8
|
+
|
|
9
|
+
Present information in this order:
|
|
10
|
+
|
|
11
|
+
1. Prerequisite conditions and applicable safety instructions.
|
|
12
|
+
2. One command for each independent action.
|
|
13
|
+
3. Expected result, when the reader must verify it.
|
|
14
|
+
4. Recovery or escalation action, when the source supplies one.
|
|
15
|
+
|
|
16
|
+
Do not move a command into a note. Do not invent missing steps or sequence.
|
|
17
|
+
|
|
18
|
+
## Error Message
|
|
19
|
+
|
|
20
|
+
Include only the fields that are known:
|
|
21
|
+
|
|
22
|
+
1. What failed.
|
|
23
|
+
2. Why it failed.
|
|
24
|
+
3. What effect the failure has.
|
|
25
|
+
4. What the user can do next.
|
|
26
|
+
5. A stable identifier or context value.
|
|
27
|
+
|
|
28
|
+
Separate facts from possible causes. Preserve quoted system messages, codes, paths, and
|
|
29
|
+
identifiers unless the user asks to rewrite those exact values.
|
|
30
|
+
|
|
31
|
+
## API or Tool Documentation
|
|
32
|
+
|
|
33
|
+
Present:
|
|
34
|
+
|
|
35
|
+
1. The operation and its purpose.
|
|
36
|
+
2. Required inputs and prerequisites.
|
|
37
|
+
3. Constraints and defaults.
|
|
38
|
+
4. The result.
|
|
39
|
+
5. Errors and recovery actions.
|
|
40
|
+
6. A minimal example when it adds necessary clarity.
|
|
41
|
+
|
|
42
|
+
Keep API names, parameter names, commands, flags, code, and protocol terms unchanged.
|
|
43
|
+
|
|
44
|
+
## Prompt or Agent Instruction
|
|
45
|
+
|
|
46
|
+
State:
|
|
47
|
+
|
|
48
|
+
1. The objective.
|
|
49
|
+
2. The scope and supplied inputs.
|
|
50
|
+
3. Required actions and decision conditions.
|
|
51
|
+
4. Constraints and protected content.
|
|
52
|
+
5. The expected output.
|
|
53
|
+
6. Stop, escalation, or uncertainty behavior when it matters.
|
|
54
|
+
|
|
55
|
+
Make ownership explicit when more than one agent or tool can act.
|
|
56
|
+
|
|
57
|
+
## Status or Incident Report
|
|
58
|
+
|
|
59
|
+
Separate:
|
|
60
|
+
|
|
61
|
+
1. Observed facts.
|
|
62
|
+
2. User or system impact.
|
|
63
|
+
3. Confirmed cause and unconfirmed hypotheses.
|
|
64
|
+
4. Completed and current actions.
|
|
65
|
+
5. Next action, owner, or checkpoint when provided.
|
|
66
|
+
|
|
67
|
+
Use time references that are unambiguous in the target context. Do not present a hypothesis as a
|
|
68
|
+
fact.
|
|
69
|
+
|
|
70
|
+
## Release Note, Commit, or Pull Request
|
|
71
|
+
|
|
72
|
+
State:
|
|
73
|
+
|
|
74
|
+
1. What changed.
|
|
75
|
+
2. Why it changed or what user-visible effect it has.
|
|
76
|
+
3. What component or audience it affects.
|
|
77
|
+
4. How the change was verified.
|
|
78
|
+
5. Known limitations or required user actions.
|
|
79
|
+
|
|
80
|
+
Do not add promotional claims to a technical summary.
|
|
81
|
+
|
|
82
|
+
## Support or UI Text
|
|
83
|
+
|
|
84
|
+
Name the problem or action directly. Use the same terms that the interface uses. Give the next
|
|
85
|
+
action before secondary explanation when the reader must act.
|
|
86
|
+
|
|
87
|
+
Treat exact UI labels, control names, placeholders, and external error text as protected literals
|
|
88
|
+
unless the task explicitly targets them for revision.
|
|
89
|
+
|
|
90
|
+
## Translation-ready Text
|
|
91
|
+
|
|
92
|
+
Use self-contained sentences and stable sentence boundaries. Repeat terminology instead of
|
|
93
|
+
rotating synonyms. Make conditions, negation, quantities, units, and references explicit.
|
|
94
|
+
|
|
95
|
+
Preserve placeholders, markup, segmentation controls, and variables exactly.
|