write-skills 0.3.0 → 0.3.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/package.json
CHANGED
|
@@ -77,6 +77,19 @@ At every depth, copy code, commands, paths, numbers, and error text exactly. Def
|
|
|
77
77
|
|
|
78
78
|
After the draft, open `references/ai-patterns.md`. Find every pattern in the draft. Rewrite each match.
|
|
79
79
|
|
|
80
|
+
## Rich styling
|
|
81
|
+
|
|
82
|
+
Use styling to guide the eye. One device marks one point.
|
|
83
|
+
|
|
84
|
+
- Bold: the verdict or the one key fact of the reply. Bold a word or a short phrase, never a sentence, and never twice in one reply.
|
|
85
|
+
- Inline code: anything a person types or reads from a screen. Commands, paths, symbols, and error text.
|
|
86
|
+
- Italics: a term at its first definition. Nothing else.
|
|
87
|
+
- Headings: only when the reply has 3 or more distinct sections.
|
|
88
|
+
- Lists and tables: 3 or more parallel items. Fewer items stay in the sentence.
|
|
89
|
+
- Blockquote: the words of another person, quoted exact.
|
|
90
|
+
- No color codes, no capital-letter shouting, no underline. Chat hosts render none of these.
|
|
91
|
+
- When the host shows plain text only, write plain text. Strip the markup.
|
|
92
|
+
|
|
80
93
|
## Brief voice
|
|
81
94
|
|
|
82
95
|
Level 4 runs here. Chat replies only. Saved text uses level 2 or higher.
|
|
@@ -101,6 +114,7 @@ Leave the brief voice for a security warning, an irreversible action, an order t
|
|
|
101
114
|
- Is every sentence 25 words or fewer, with one idea?
|
|
102
115
|
- Is the voice active? Are the terms stable?
|
|
103
116
|
- Did you remove every pattern from `references/ai-patterns.md`?
|
|
117
|
+
- Does every styling device mark a different point, at most one bold per reply?
|
|
104
118
|
- Does the last sentence add a fact? Delete a recap or an offer of help.
|
|
105
119
|
|
|
106
120
|
## Safety and conflicts
|
|
@@ -50,6 +50,22 @@ Jobs stay separate. Split the page and link, rather than mixing.
|
|
|
50
50
|
11. One thing carries one name across the whole document.
|
|
51
51
|
12. Name the real symbols, paths, flags, and commands. The codebase supplies the words.
|
|
52
52
|
|
|
53
|
+
## Style the page
|
|
54
|
+
|
|
55
|
+
Markdown carries the structure. Use the devices in order of strength.
|
|
56
|
+
|
|
57
|
+
1. Headings carry the plan of the page. One h1, no skipped levels.
|
|
58
|
+
2. Fenced code with a language tag. Use a diff fence for a change to existing code.
|
|
59
|
+
3. Callouts for what the reader must act on, when the platform supports them:
|
|
60
|
+
```markdown
|
|
61
|
+
> [!WARNING]
|
|
62
|
+
> A column rename fails the build.
|
|
63
|
+
```
|
|
64
|
+
4. Tables for comparisons that share 2 or more properties.
|
|
65
|
+
5. Bold lead-ins only when the label names the item and the line adds new detail.
|
|
66
|
+
6. Images carry alt text that states what the image shows.
|
|
67
|
+
7. No color codes in the text. Markdown has none. Emphasis comes from structure, not paint.
|
|
68
|
+
|
|
53
69
|
## Revise an existing document
|
|
54
70
|
|
|
55
71
|
1. Read the whole page once before you change a line.
|
|
@@ -78,6 +78,21 @@ A page can pass every rule and still read like a machine wrote it. Every sentenc
|
|
|
78
78
|
- Take a position where the job allows it. Explanation weighs options, so say which one you favor. Reference stays neutral.
|
|
79
79
|
- Trade the sterile for the particular. "Schema changes can cause issues" says nothing; "a column rename fails the build" says the thing.
|
|
80
80
|
|
|
81
|
+
## Style the page
|
|
82
|
+
|
|
83
|
+
Markdown carries the structure. The devices, in order of strength:
|
|
84
|
+
|
|
85
|
+
1. **Headings** carry the plan of the page. One h1, no skipped levels, sentence case.
|
|
86
|
+
2. **Fenced code** with a language tag. Use a `diff` fence for a change to existing code, so the reader sees the shape of the change before its content.
|
|
87
|
+
3. **Callouts** for what the reader must act on: note, tip, important, warning, caution, when the platform renders them. One callout carries one instruction.
|
|
88
|
+
4. **Tables** for comparisons that share 2 or more properties. Three paragraphs of parallel facts become one table.
|
|
89
|
+
5. **Bold lead-ins** only when the label names the item and the line adds new detail. A label that restates the line is noise.
|
|
90
|
+
6. **Images** carry alt text that states what the image shows. A diagram gets a one-line text summary beside it.
|
|
91
|
+
7. **Collapsed sections** for long output the reader may skip: logs, matrices, raw data. The summary line names what sits inside.
|
|
92
|
+
8. **Links** say where they go, in their own words.
|
|
93
|
+
|
|
94
|
+
No color codes anywhere. Markdown carries none, and a hex code or an escape sequence in prose renders as noise. Emphasis comes from structure: the heading, the callout, the table, the fence. When a page needs more paint than structure, the page is not arranged yet.
|
|
95
|
+
|
|
81
96
|
## Claims and evidence
|
|
82
97
|
|
|
83
98
|
- Write the symbols and paths that exist at this commit.
|
package/skills/write-pr/SKILL.md
CHANGED
|
@@ -59,6 +59,30 @@ Pick the smallest view that makes the point. One sketch is enough for most chang
|
|
|
59
59
|
- Show a control flow change as a diff of the call tree.
|
|
60
60
|
- Show a UI change with a screenshot when the environment allows it.
|
|
61
61
|
|
|
62
|
+
## Formatting
|
|
63
|
+
|
|
64
|
+
The host renders markdown. Use the devices it renders.
|
|
65
|
+
|
|
66
|
+
- Bold the two risk verdicts: the door and the blast radius. Bold nothing else.
|
|
67
|
+
- Use a diff fence for a code change. Give every fence a language tag.
|
|
68
|
+
- Collapse long output behind a summary line:
|
|
69
|
+
```markdown
|
|
70
|
+
<details>
|
|
71
|
+
<summary>Full test log, 214 lines</summary>
|
|
72
|
+
|
|
73
|
+
The log text sits here, or a fenced block with a language tag.
|
|
74
|
+
|
|
75
|
+
</details>
|
|
76
|
+
```
|
|
77
|
+
- Use the alert callouts of the host for a one-way door:
|
|
78
|
+
```markdown
|
|
79
|
+
> [!WARNING]
|
|
80
|
+
> This change drops the old table. Run the migration before the next deploy.
|
|
81
|
+
```
|
|
82
|
+
- Use a table for before and after numbers.
|
|
83
|
+
- Use a task list for follow-up work the reviewer must check.
|
|
84
|
+
- No color codes. The host renders none.
|
|
85
|
+
|
|
62
86
|
## Rules
|
|
63
87
|
|
|
64
88
|
- State what the change does first. State why second.
|