pi-feature-dev 1.5.0 → 1.7.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 CHANGED
@@ -1,6 +1,6 @@
1
1
  # pi-feature-dev
2
2
 
3
- Portable coding-agent workflows, packaged as Pi skills.
3
+ Portable agent workflows and writing skills, packaged as Pi skills.
4
4
 
5
5
  The `feature-dev` skill describes a tool-agnostic process for non-trivial
6
6
  feature work:
@@ -23,6 +23,13 @@ The `grill` skill runs a dependency-aware interview that researches facts,
23
23
  exhausts the current decision frontier round by round, sharpens domain language,
24
24
  and records agreed terminology and durable architectural decisions.
25
25
 
26
+ The `ste` skill drafts, rewrites, and reviews clear English with
27
+ [ASD-STE100 Simplified Technical English](https://www.asd-ste100.org/)
28
+ principles. It supports strict technical-documentation work and a general
29
+ clarity mode for prompts, tool descriptions, error messages, status reports,
30
+ translation-ready text, and agent instructions. The skill is Markdown-only and
31
+ has no runtime dependency.
32
+
26
33
  ## Install
27
34
 
28
35
  ```
@@ -65,6 +72,8 @@ versions came from:
65
72
  - [umputun/cc-thingz](https://github.com/umputun/cc-thingz)
66
73
  - [anthropics/claude-code feature-dev plugin](https://github.com/anthropics/claude-code/tree/main/plugins/feature-dev)
67
74
  - [mattpocock/skills batch-grill-me and domain-modeling skills](https://github.com/mattpocock/skills)
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)
68
77
 
69
78
  ## Usage
70
79
 
@@ -80,7 +89,8 @@ Natural language also works when Pi's skill matcher triggers:
80
89
  Use feature-dev to implement API rate limiting.
81
90
  ```
82
91
 
83
- The `skills/feature-dev/SKILL.md` file is portable markdown and can be adapted for other coding assistant environments.
92
+ The files under `skills/*/SKILL.md` are portable Markdown and can be adapted for
93
+ other agent environments.
84
94
 
85
95
  Run a plan with `plan-exec`:
86
96
 
@@ -94,6 +104,18 @@ Stress-test an idea before planning or implementation:
94
104
  /skill:grill Challenge the design for usage-based billing.
95
105
  ```
96
106
 
107
+ Rewrite technical or operational English:
108
+
109
+ ```text
110
+ /skill:ste Rewrite this maintenance instruction as an STE-aligned draft.
111
+ ```
112
+
113
+ Use STE principles for general agent communication:
114
+
115
+ ```text
116
+ /skill:ste Rewrite this error message so another agent can parse it reliably.
117
+ ```
118
+
97
119
  This package is intentionally skill-only. It does not provide prompt template shortcuts; use `/skill:<name>` for explicit Pi invocation.
98
120
 
99
121
  ## Feature-dev workflow
@@ -108,6 +130,21 @@ The `feature-dev` skill guides a coding assistant through a seven-phase process:
108
130
  6. Quality review — inspect the diff from correctness, validation, and maintainability perspectives
109
131
  7. Validation and summary — run focused checks and summarize changes
110
132
 
133
+ ## STE modes
134
+
135
+ The `ste` skill selects one of two modes:
136
+
137
+ - **Strict STE** applies Issue 9 rules to regulated, operational, maintenance,
138
+ and safety-critical documentation. Exact verification requires the official
139
+ dictionary and the applicable project glossary.
140
+ - **STE clarity** transfers the same clarity discipline to other technical
141
+ text without claiming formal ASD-STE100 compliance.
142
+
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
146
+ `skills/ste/README.md`, outside the agent's writing context.
147
+
111
148
  ## Package contents
112
149
 
113
150
  ```text
@@ -130,8 +167,17 @@ pi-feature-dev/
130
167
  ├── plan-make/
131
168
  │ ├── agents/openai.yaml
132
169
  │ └── SKILL.md
133
- └── plan-review/
170
+ ├── plan-review/
171
+ │ ├── agents/openai.yaml
172
+ │ └── SKILL.md
173
+ └── ste/
134
174
  ├── agents/openai.yaml
175
+ ├── references/
176
+ │ ├── before-after.md
177
+ │ ├── checklist.md
178
+ │ ├── use-cases.md
179
+ │ └── writing-rules.md
180
+ ├── README.md
135
181
  └── SKILL.md
136
182
  ```
137
183
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pi-feature-dev",
3
- "version": "1.5.0",
3
+ "version": "1.7.0",
4
4
  "description": "Portable coding-agent workflows packaged as skills.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -0,0 +1,47 @@
1
+ # STE Skill
2
+
3
+ This project skill applies ASD-STE100 Simplified Technical English principles to:
4
+
5
+ - regulated and safety-critical technical documentation;
6
+ - procedures and technical descriptions;
7
+ - prompts, tool descriptions, error messages, and agent instructions;
8
+ - controlled or translation-ready English.
9
+
10
+ The skill is Markdown-only and has no runtime or tool dependency.
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
+
15
+ ## Standard Baseline
16
+
17
+ The skill uses ASD-STE100 Simplified Technical English, Issue 9, dated 2025-01-15.
18
+ Issue 9 contains 53 writing rules in nine sections. Its dictionary contains 875 approved entries
19
+ and 1,274 selected unapproved entries.
20
+
21
+ Authoritative sources:
22
+
23
+ - [ASD-STE100 official site](https://www.asd-ste100.org/)
24
+ - [Official downloads page](https://www.asd-ste100.org/STE_downloads.html)
25
+ - [Official Issue 9 PDF](https://www.asd-ste100.org/assets/files/ASD-STE100_ISSUE9.pdf)
26
+
27
+ ## Verification Boundary
28
+
29
+ This skill paraphrases the writing method. It does not reproduce the official controlled
30
+ dictionary or replace the authoritative standard.
31
+
32
+ Use the official Issue 9 dictionary and the applicable project glossary for strict verification.
33
+ Without those checks, describe the result as an `STE-aligned draft` or an `STE-style rewrite`,
34
+ not as a compliant or certified document.
35
+
36
+ ASD owns the copyright and trademarks for ASD-STE100. Do not copy the official dictionary or
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.
@@ -0,0 +1,148 @@
1
+ ---
2
+ name: ste
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
+ ---
5
+
6
+ # STE
7
+
8
+ Write English that has one clear meaning and a structure that is easy to parse. Preserve technical
9
+ accuracy before you simplify language.
10
+
11
+ ## Select the Operating Mode
12
+
13
+ Use **strict STE mode** when the user requests ASD-STE100 compliance or works on regulated,
14
+ maintenance, operational, or safety-critical documentation.
15
+
16
+ - Apply Issue 9 rules and the applicable project directives.
17
+ - Verify general vocabulary against the official Issue 9 dictionary.
18
+ - Verify technical nouns and verbs against the project glossary.
19
+ - Use `STE-aligned draft` when these lexical checks are not possible.
20
+
21
+ Use **STE clarity mode** for prompts, tool descriptions, error messages, agent instructions,
22
+ status reports, translation-ready text, and other technical or operational English.
23
+
24
+ - Transfer the clarity rules that fit the text.
25
+ - Prefer explicit actors, actions, conditions, inputs, and results.
26
+ - Do not imply formal ASD-STE100 compliance.
27
+
28
+ ## Load References Selectively
29
+
30
+ - Read [references/writing-rules.md](references/writing-rules.md) for strict STE work, compliance
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.
36
+ - Read [references/before-after.md](references/before-after.md) when rewriting dense text,
37
+ explaining changes, or producing a comparison.
38
+ - Read all user-supplied glossaries, safety policies, style guides, and regulatory directives that
39
+ apply.
40
+
41
+ If sources conflict, follow the explicit regulatory or project requirement and report the
42
+ deviation. Do not merge inconsistent terminology.
43
+
44
+ ## Preserve Meaning
45
+
46
+ Before rewriting:
47
+
48
+ 1. Identify each fact, action, condition, limit, unit, exception, warning, causal relation, and
49
+ cross-reference.
50
+ 2. Resolve what each pronoun and modifier refers to.
51
+ 3. Keep the original sequence and scope unless the user authorizes a technical change.
52
+ 4. Ask when ambiguity can change safety, responsibility, or task outcome.
53
+
54
+ Do not invent missing facts. Do not remove precision only to meet a length target.
55
+ Keep a qualitative modifier such as `carefully` when it affects task intent. Flag it when the
56
+ project requires a measurable criterion, but do not invent that criterion.
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
+
70
+ ## Apply the Core Discipline
71
+
72
+ | Area | Apply |
73
+ |---|---|
74
+ | Vocabulary | Use one familiar word for one meaning. In strict mode, confirm its approved meaning, part of speech, and form. |
75
+ | Terminology | Use one term for one concept. Keep necessary domain terms and define or flag unclear terms. |
76
+ | Verbs | Prefer active voice, simple tenses, and direct action verbs. Avoid noun-heavy and complex auxiliary constructions. |
77
+ | Instructions | Use the imperative form. Put one independent action in each sentence. Combine actions only when they occur at the same time. Put prerequisite conditions first. |
78
+ | Length | Use no more than 20 words for procedures and 25 words for descriptions under Issue 9 counting rules. |
79
+ | Noun phrases | Keep multi-word nouns to three words when possible. Preserve longer official names and define a clear short form if needed. |
80
+ | Structure | Use complete sentences, one topic per paragraph, and vertical lists for complex sequences or alternatives. |
81
+ | Safety | Start with the required command or condition, then state the risk or possible result. Never infer the risk level. |
82
+ | Consistency | Reuse the same wording for the same action and context. Do not rotate synonyms for style. |
83
+
84
+ ## Rewrite in Passes
85
+
86
+ 1. Classify each section as instruction, description, safety text, or mixed content.
87
+ 2. Read for meaning before changing words.
88
+ 3. Record repeated or uncertain terms when terminology control matters.
89
+ 4. Find ambiguity, indirect wording, complex tense, passive voice, omitted words, long noun
90
+ phrases, overloaded sentences, and inconsistent terminology.
91
+ 5. In procedural text, count the independent actions in each sentence. Split actions that do not
92
+ occur at the same time.
93
+ 6. Rewrite only the text that benefits from a change.
94
+ 7. Compare the result with the source. Confirm that all facts, conditions, limits, exceptions,
95
+ and responsibilities remain.
96
+ 8. Review sentence length, paragraph structure, punctuation, and term consistency manually.
97
+
98
+ If the input is already clear and meets the applicable rules, say so. Do not force a rewrite.
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
+
112
+ ## Choose the Output
113
+
114
+ For a direct drafting or rewriting request:
115
+
116
+ 1. Give the revised text first.
117
+ 2. Add `Unresolved checks` only when lexical, technical, regulatory, or safety facts remain
118
+ unverified.
119
+
120
+ For an audit or an explained rewrite, use:
121
+
122
+ | Rule area | Original | Revised | Reason |
123
+ |---|---|---|---|
124
+ | Concise rule name | Exact source fragment | Replacement | What ambiguity or violation the change removes |
125
+
126
+ After the table, give the complete revised text. Group unresolved items as:
127
+
128
+ - `Confirmed issue`
129
+ - `Manual review`
130
+ - `Project decision`
131
+
132
+ Use the user's requested format when it conflicts with these defaults.
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
+
138
+ ## State Verification Honestly
139
+
140
+ Use one of these statuses only when a status is useful:
141
+
142
+ - `STE-style rewrite` for general-purpose clarity mode.
143
+ - `STE-aligned draft` when Issue 9 or project terminology checks are incomplete.
144
+ - `Verified against Issue 9 and project terminology` only when those checks occurred.
145
+
146
+ Do not call the result certified. Do not reproduce the official dictionary. Do not apply STE
147
+ mechanically to creative, marketing, or persuasive text unless the user explicitly values
148
+ literal clarity more than voice.
@@ -0,0 +1,4 @@
1
+ interface:
2
+ display_name: "STE"
3
+ short_description: "Write clear, unambiguous English with STE"
4
+ default_prompt: "Use $ste to rewrite this text for clear, unambiguous technical communication."
@@ -0,0 +1,131 @@
1
+ # Before and After Examples
2
+
3
+ Use these original examples to recognize rewrite patterns. They illustrate the skill workflow.
4
+ They are not evidence that a word is approved in the official ASD-STE100 dictionary.
5
+
6
+ ## Contents
7
+
8
+ - [Maintenance procedure](#maintenance-procedure)
9
+ - [Tool description](#tool-description)
10
+ - [Error message](#error-message)
11
+ - [Agent instruction](#agent-instruction)
12
+ - [Status report](#status-report)
13
+ - [Terminology consistency](#terminology-consistency)
14
+ - [Already clear text](#already-clear-text)
15
+
16
+ ## Maintenance Procedure
17
+
18
+ **Before**
19
+
20
+ > Prior to carrying out removal of the filter housing, the technician should ensure that
21
+ > electrical power has been disconnected, and thereafter the retaining bolts should be taken
22
+ > off.
23
+
24
+ **Issues**
25
+
26
+ - Indirect instruction.
27
+ - Passive voice.
28
+ - Noun-heavy construction.
29
+ - More than one instruction in one sentence.
30
+
31
+ **After**
32
+
33
+ > Disconnect electrical power.
34
+ >
35
+ > Remove the retaining bolts.
36
+ >
37
+ > Remove the filter housing.
38
+
39
+ **Unresolved check:** Confirm that these steps have the correct sequence and that the project
40
+ glossary approves `retaining bolt` and `filter housing`.
41
+
42
+ ## Tool Description
43
+
44
+ **Before**
45
+
46
+ > This tool is intended to facilitate the synchronization of configuration values across all of
47
+ > the services that have been selected.
48
+
49
+ **After**
50
+
51
+ > The tool synchronizes configuration values across the selected services.
52
+
53
+ **Why:** The revision identifies the actor and action directly. It removes a nominalization and a
54
+ passive construction.
55
+
56
+ ## Error Message
57
+
58
+ **Before**
59
+
60
+ > The request could not be completed due to the fact that the credentials which were provided
61
+ > are no longer valid.
62
+
63
+ **After**
64
+
65
+ > The request failed because the credentials expired.
66
+
67
+ **Why:** The revision separates the result from the cause and removes indirect wording. Confirm
68
+ that expiration is the actual cause before using this message.
69
+
70
+ ## Agent Instruction
71
+
72
+ **Before**
73
+
74
+ > Once the build has finished, the agent should inspect the report and then, if any failures have
75
+ > been identified, it should post a summary.
76
+
77
+ **After**
78
+
79
+ > Wait for the build to finish.
80
+ >
81
+ > Inspect the report.
82
+ >
83
+ > If the report shows failures, post a summary.
84
+
85
+ **Why:** The revision uses direct commands, simple verb forms, an explicit condition, and one
86
+ instruction per sentence.
87
+
88
+ ## Status Report
89
+
90
+ **Before**
91
+
92
+ > We have successfully completed the database migration, which was performed after all of the
93
+ > validation checks had been carried out.
94
+
95
+ **After**
96
+
97
+ > We completed all validation checks. Then we migrated the database.
98
+
99
+ **Why:** The revision uses simple past tense and makes the sequence explicit. Keep `successfully`
100
+ only when it communicates a defined result that the text must preserve.
101
+
102
+ ## Terminology Consistency
103
+
104
+ **Before**
105
+
106
+ > Check the connection. Verify the cable. Confirm the plug.
107
+
108
+ **Decision**
109
+
110
+ Do not replace these verbs automatically. First determine whether they describe one action or
111
+ three different actions.
112
+
113
+ **After, only if the intended action is identical**
114
+
115
+ > Check the connection. Check the cable. Check the plug.
116
+
117
+ **Why:** STE favors one term for one concept, but terminology consistency must not erase a real
118
+ technical distinction.
119
+
120
+ ## Already Clear Text
121
+
122
+ **Input**
123
+
124
+ > Close the inlet valve. Disconnect the power cable.
125
+
126
+ **Result**
127
+
128
+ Keep the text unchanged if the terms are correct for the project.
129
+
130
+ **Why:** A rewrite is not an objective by itself. Change text only when the change improves
131
+ clarity, correctness, or compliance.
@@ -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.
@@ -0,0 +1,257 @@
1
+ # ASD-STE100 Issue 9 Writing Rules
2
+
3
+ ## Contents
4
+
5
+ - [Decision priority](#decision-priority)
6
+ - [Vocabulary and terminology](#vocabulary-and-terminology)
7
+ - [Compact rule coverage map](#compact-rule-coverage-map)
8
+ - [Issue 9 general recommendations](#issue-9-general-recommendations)
9
+ - [General-purpose transfer](#general-purpose-transfer)
10
+ - [Authoring templates](#authoring-templates)
11
+ - [Review protocol](#review-protocol)
12
+
13
+ ## Decision Priority
14
+
15
+ Apply these priorities:
16
+
17
+ 1. Preserve technical accuracy, safety intent, limits, and required sequence.
18
+ 2. Follow applicable law, regulation, customer requirements, and project directives.
19
+ 3. Apply the current Issue 9 rule and dictionary entry.
20
+ 4. Use the approved project glossary for technical nouns and technical verbs.
21
+ 5. Prefer one clear construction when more than one construction is permitted.
22
+
23
+ If priorities conflict, select the higher-priority requirement and report the conflict. Do not merge
24
+ two inconsistent wordings.
25
+
26
+ ## Vocabulary and Terminology
27
+
28
+ Use only these word classes:
29
+
30
+ - A general word approved in the Issue 9 dictionary.
31
+ - A technical noun applicable to the subject field.
32
+ - A technical verb applicable to the subject field.
33
+
34
+ For an approved general word, verify all of these properties:
35
+
36
+ - Part of speech.
37
+ - Approved meaning.
38
+ - Approved inflected form.
39
+ - Correct use in the sentence.
40
+
41
+ Treat a project term as a technical noun only when it names a precise subject-field concept. Use
42
+ terms from drawings, parts data, standards, official documents, and the approved project
43
+ glossary. Issue 9 organizes technical nouns into broad areas such as parts, machines, tools,
44
+ materials, systems, science, navigation, measurements, quoted labels, roles, medical concepts,
45
+ documents, conditions, colors, damage, computing, operations, law, and living things.
46
+
47
+ Treat a project verb as a technical verb only when it names a precise subject-field process.
48
+ Issue 9 permits categories for manufacturing, computer operations, applicable technical fields,
49
+ and legal or regulatory texts. Use a dictionary-approved verb instead when it communicates the
50
+ same action accurately.
51
+
52
+ Apply these terminology controls:
53
+
54
+ - Use one technical noun for one item.
55
+ - Do not use a technical noun as a verb.
56
+ - Do not use a technical verb as a noun.
57
+ - Prefer short, familiar, project-approved terms.
58
+ - Reject slang, regional wording, and unexplained jargon.
59
+ - Define an abbreviation at first use unless the audience and governing directive make it
60
+ unnecessary.
61
+ - Keep quoted interface text, placards, labels, and identifiers unchanged.
62
+
63
+ ## Compact Rule Coverage Map
64
+
65
+ Use this map to confirm coverage. Consult the authoritative standard for definitions, exceptions,
66
+ dictionary entries, and official examples.
67
+
68
+ ### Words (Issue 9 section 1)
69
+
70
+ - Limit vocabulary to approved general words, technical nouns, and technical verbs.
71
+ - Use each approved word only with its listed part of speech, meaning, and form.
72
+ - Validate technical nouns and verbs by category and project authority.
73
+ - Keep one term for one concept and do not change noun/verb roles.
74
+ - Use American English spelling unless an official directive overrides it.
75
+
76
+ ### Multi-word nouns (section 2)
77
+
78
+ - Keep a multi-word noun to three words or fewer when possible.
79
+ - When the official term is longer, write it in full first. Then define a clear short form or use
80
+ hyphens to show words that function as one unit.
81
+ - Do not shorten a term in a way that creates ambiguity.
82
+
83
+ ### Verbs (section 3)
84
+
85
+ - Use only approved verb forms.
86
+ - Use the infinitive, imperative, simple present, simple past, simple future, or a past participle
87
+ used as an adjective.
88
+ - Avoid complex auxiliary constructions.
89
+ - Use an `-ing` form only as a technical noun or as a modifier inside a technical noun.
90
+ - Prefer active voice. In descriptive text, use passive voice only when the agent is unknown.
91
+ - Express an action with an accurate verb, not a noun-heavy construction.
92
+
93
+ ### Sentences (section 4)
94
+
95
+ - Write short, complete, explicit sentences.
96
+ - Do not omit necessary words and do not use contractions.
97
+ - Convert complex series or alternatives into vertical lists.
98
+ - Use clear connecting words between related statements.
99
+ - Use an article or demonstrative adjective before a noun when English grammar requires one.
100
+
101
+ ### Procedures (section 5)
102
+
103
+ - Limit each sentence to 20 words.
104
+ - Put one instruction in each sentence, except for actions that occur at the same time.
105
+ - Count independent actions, not only grammatical clauses. Do not join sequential actions with
106
+ `and`.
107
+ - Use the imperative form.
108
+ - Put a prerequisite condition before the command and separate it with a comma.
109
+ - Keep commands out of notes.
110
+
111
+ ### Descriptions (section 6)
112
+
113
+ - Present information gradually and in a logical sequence.
114
+ - Repeat key terms where they make structure clear.
115
+ - Limit each sentence to 25 words.
116
+ - Keep one topic in each paragraph.
117
+ - Limit each paragraph to six sentences.
118
+
119
+ ### Safety instructions (section 7)
120
+
121
+ - Identify risk with the label required by the applicable safety system.
122
+ - Begin with a clear command or condition.
123
+ - Explain the risk or possible result.
124
+ - Preserve official safety wording when a governing directive prohibits changes.
125
+
126
+ ### Punctuation and word count (section 8)
127
+
128
+ - Do not use semicolons.
129
+ - Use hyphens only to connect words that function together.
130
+ - Use parentheses only for clear supporting purposes, such as references, identifiers,
131
+ abbreviations, alternatives, or brief explanations.
132
+ - In a vertical list, treat the introductory colon as a sentence boundary for word count.
133
+ - Count a complete parenthetical group as one word.
134
+ - Count each number, number-plus-unit, abbreviation, alphanumeric identifier, quoted text,
135
+ title, label, and applicable proper name as one word.
136
+ - Count a hyphenated unit as one word.
137
+
138
+ ### Writing practices (section 9)
139
+
140
+ - Restructure a sentence when a word-for-word synonym change is not sufficient.
141
+ - Confirm the meaning and grammar of each approved word.
142
+ - Do not create phrasal verbs.
143
+ - Use the same terminology and wording for the same context.
144
+
145
+ ## Issue 9 General Recommendations
146
+
147
+ Apply these recommendations when they improve clarity:
148
+
149
+ - Include `that` when it clearly marks the start of a subordinate clause.
150
+ - Review each use of `with` for multiple possible meanings.
151
+ - Replace an ambiguous pronoun with its noun.
152
+ - Make the referent of `this` explicit.
153
+ - Check false friends when the author is not a native English speaker.
154
+ - Replace Latin abbreviations with plain English.
155
+ - Use inclusive, gender-neutral language.
156
+ - Avoid a possessive form when it can confuse the reader.
157
+
158
+ These recommendations help quality but are not part of the 53 rules.
159
+
160
+ ## General-Purpose Transfer
161
+
162
+ For prompts, tool descriptions, error messages, agent instructions, and status reports:
163
+
164
+ - Treat a command as procedural text and an explanation as descriptive text.
165
+ - Name the actor when responsibility matters.
166
+ - State conditions before the action that depends on them.
167
+ - Separate actual results from possible causes and suggested recovery actions.
168
+ - Replace vague references such as `it`, `this`, and `they` when more than one referent is
169
+ possible.
170
+ - Keep API names, identifiers, quoted UI text, code, and protocol terms unchanged.
171
+ - Define a necessary domain term once and use it consistently.
172
+
173
+ For translation-ready text:
174
+
175
+ - Prefer repeated terminology over stylistic variation.
176
+ - Keep sentence boundaries aligned with complete ideas.
177
+ - Make negation, quantities, units, and conditions explicit.
178
+
179
+ Use the status `STE-style rewrite` for these transferred applications unless strict verification
180
+ also occurred.
181
+
182
+ ## Authoring Templates
183
+
184
+ ### Procedure
185
+
186
+ Use this pattern:
187
+
188
+ ```text
189
+ If [prerequisite condition], [imperative command].
190
+ [Imperative command].
191
+ [Imperative command].
192
+
193
+ NOTE: [Information only.]
194
+ ```
195
+
196
+ Example:
197
+
198
+ ```text
199
+ If the pressure is more than 500 kPa, stop the pump.
200
+ Close the inlet valve.
201
+ Disconnect the power cable.
202
+
203
+ NOTE: The indicator can stay on for 5 seconds.
204
+ ```
205
+
206
+ ### Description
207
+
208
+ Use this pattern:
209
+
210
+ ```text
211
+ [Identify the item and its primary function.]
212
+ [Explain the next fact with the same key terminology.]
213
+ [State a condition and its result.]
214
+ ```
215
+
216
+ Example:
217
+
218
+ ```text
219
+ The controller monitors the inlet pressure. It sends a stop signal when the pressure is more than
220
+ 500 kPa.
221
+ ```
222
+
223
+ ### Safety instruction
224
+
225
+ Use the label from the governing safety policy:
226
+
227
+ ```text
228
+ [RISK LABEL]: [Command or condition]. [Risk or possible result.]
229
+ ```
230
+
231
+ Example:
232
+
233
+ ```text
234
+ WARNING: Disconnect electrical power before you open the housing. Electrical power can cause
235
+ injury.
236
+ ```
237
+
238
+ Do not reuse the example risk level without validating it for the real hazard.
239
+
240
+ ## Review Protocol
241
+
242
+ Review in separate passes:
243
+
244
+ 1. **Meaning:** Compare source and output action by action. Confirm conditions, negation, limits,
245
+ units, sequence, references, and consequences.
246
+ 2. **Vocabulary:** Verify each general word in the Issue 9 dictionary. Record technical nouns and
247
+ technical verbs in the term ledger.
248
+ 3. **Grammar:** Check verb form, voice, articles, complete constructions, pronouns, and
249
+ modifiers.
250
+ 4. **Structure:** Apply the procedure, description, or safety pattern.
251
+ 5. **Mechanics:** Apply sentence and paragraph limits, punctuation, spelling, and word-count
252
+ rules.
253
+ 6. **Consistency:** Search for alternate names and alternate wording for the same concept or
254
+ action.
255
+
256
+ Record unverified items. A clear limitation is more accurate than an unsupported claim of
257
+ compliance.