writing-skills 0.2.0 → 0.3.2
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/.claude-plugin/marketplace.json +35 -0
- package/.claude-plugin/plugin.json +26 -0
- package/README.md +60 -40
- package/exhaustive-styles.json +1952 -0
- package/mcp.json +10 -0
- package/package.json +5 -2
- package/plugin.json +1 -1
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "writing-skills",
|
|
3
|
+
"owner": {
|
|
4
|
+
"name": "Surendran B",
|
|
5
|
+
"url": "https://github.com/surendranb"
|
|
6
|
+
},
|
|
7
|
+
"metadata": {
|
|
8
|
+
"description": "Procedural writing-style skills for AI agents — official frameworks, not vibes.",
|
|
9
|
+
"version": "0.3.2"
|
|
10
|
+
},
|
|
11
|
+
"plugins": [
|
|
12
|
+
{
|
|
13
|
+
"name": "writing-skills",
|
|
14
|
+
"source": "./",
|
|
15
|
+
"description": "14 writing-style skills: 7 measurable frameworks (plain language, BLUF business writing, corporate comms, GOV.UK, ASD-STE100, Google dev docs, AP journalism) and 7 character voices (Ted Lasso, Jack Sparrow, Shrek, Yoda, Winnie the Pooh, Paddington, Bob Ross). Each framework enforces a verifiable checklist.",
|
|
16
|
+
"strict": false,
|
|
17
|
+
"skills": [
|
|
18
|
+
"./skills/plain-language",
|
|
19
|
+
"./skills/business-writing",
|
|
20
|
+
"./skills/corporate-communication",
|
|
21
|
+
"./skills/gov-uk-style",
|
|
22
|
+
"./skills/asd-ste100",
|
|
23
|
+
"./skills/google-dev-docs",
|
|
24
|
+
"./skills/journalism-ap",
|
|
25
|
+
"./skills/ted-lasso",
|
|
26
|
+
"./skills/jack-sparrow",
|
|
27
|
+
"./skills/shrek",
|
|
28
|
+
"./skills/yoda",
|
|
29
|
+
"./skills/winnie-the-pooh",
|
|
30
|
+
"./skills/paddington",
|
|
31
|
+
"./skills/bob-ross"
|
|
32
|
+
]
|
|
33
|
+
}
|
|
34
|
+
]
|
|
35
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "writing-skills",
|
|
3
|
+
"version": "0.3.2",
|
|
4
|
+
"description": "Procedural writing-style skills for AI agents — 7 measurable frameworks and 7 character voices, each with verifiable mechanics.",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "Surendran B",
|
|
7
|
+
"url": "https://github.com/surendranb"
|
|
8
|
+
},
|
|
9
|
+
"homepage": "https://github.com/surendranb/writing-skills",
|
|
10
|
+
"repository": "https://github.com/surendranb/writing-skills",
|
|
11
|
+
"license": "MIT",
|
|
12
|
+
"keywords": [
|
|
13
|
+
"writing",
|
|
14
|
+
"writing-style",
|
|
15
|
+
"plain-language",
|
|
16
|
+
"business-writing",
|
|
17
|
+
"copywriting",
|
|
18
|
+
"voice"
|
|
19
|
+
],
|
|
20
|
+
"mcpServers": {
|
|
21
|
+
"writing-skills-mcp": {
|
|
22
|
+
"command": "uvx",
|
|
23
|
+
"args": ["writing-skills-mcp"]
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
}
|
package/README.md
CHANGED
|
@@ -1,66 +1,86 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<img src="logo.svg" alt="
|
|
2
|
+
<img src="logo.svg" alt="writing-skills logo" width="96" />
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
|
-
#
|
|
5
|
+
# writing-skills
|
|
6
|
+
|
|
7
|
+
**14 writing-style skills for AI agents: 7 measurable frameworks, 7 character voices.**
|
|
8
|
+
Plain `SKILL.md` files — no code, no server. Works in any agent that reads skills
|
|
9
|
+
(Claude Code, opencode, Codex, Cursor, Kiro, Gemini).
|
|
6
10
|
|
|
7
|
-
[](https://opensource.org/licenses/MIT)
|
|
8
|
-
[](https://pypi.org/project/writing-skills/)
|
|
9
11
|
[](https://www.npmjs.com/package/writing-skills)
|
|
12
|
+
[](https://pypi.org/project/writing-skills/)
|
|
13
|
+
[](LICENSE)
|
|
10
14
|
|
|
11
|
-
|
|
15
|
+
## Install
|
|
12
16
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
reads SKILL.md (opencode, Claude Code, Codex, Kiro, Gemini).
|
|
17
|
+
```bash
|
|
18
|
+
npx skills add writing-skills
|
|
19
|
+
```
|
|
17
20
|
|
|
18
|
-
|
|
21
|
+
One command, every agent on your machine.
|
|
19
22
|
|
|
20
|
-
|
|
23
|
+
<details>
|
|
24
|
+
<summary>Other install methods</summary>
|
|
21
25
|
|
|
22
|
-
|
|
|
26
|
+
| Harness | Command |
|
|
23
27
|
| :--- | :--- |
|
|
24
|
-
|
|
|
25
|
-
|
|
|
26
|
-
|
|
|
27
|
-
|
|
|
28
|
-
| `asd-ste100` | Safety-critical technical prose. One instruction per sentence, controlled vocabulary, no idioms. |
|
|
29
|
-
| `google-dev-docs` | Developer documentation. Active voice, present tense, verb-first headings, runnable examples. |
|
|
30
|
-
| `journalism-ap` | Factual reporting. AP attribution and number rules, zero editorializing. |
|
|
28
|
+
| Claude Code plugin | `/plugin marketplace add surendranb/writing-skills` then `/plugin install writing-skills@writing-skills` |
|
|
29
|
+
| Codex ≥ 0.147 / Kiro | `git clone https://github.com/surendranb/writing-skills.git` — `plugin.json` is auto-discovered |
|
|
30
|
+
| npm | `npm install writing-skills` |
|
|
31
|
+
| Python | `uv add writing-skills` or `pip install writing-skills` |
|
|
31
32
|
|
|
32
|
-
|
|
33
|
+
</details>
|
|
33
34
|
|
|
34
|
-
|
|
35
|
+
## Use
|
|
35
36
|
|
|
36
|
-
|
|
37
|
+
Ask for the style. The skill loads itself.
|
|
37
38
|
|
|
38
|
-
|
|
39
|
+
> "rewrite this in plain language" · "make this a BLUF business update" ·
|
|
40
|
+
> "press release in AP style" · "say it like Yoda"
|
|
41
|
+
|
|
42
|
+
Every skill ends with a `Verify` checklist the agent must pass before it delivers.
|
|
43
|
+
|
|
44
|
+
## The skills
|
|
45
|
+
|
|
46
|
+
### Frameworks — real standards, enforced
|
|
47
|
+
|
|
48
|
+
| Skill | Enforces |
|
|
39
49
|
| :--- | :--- |
|
|
40
|
-
|
|
|
41
|
-
|
|
|
42
|
-
|
|
|
43
|
-
|
|
|
44
|
-
|
|
|
50
|
+
| `plain-language` | Plain Writing Act. Sentences ≤25 words, passive ≤10%, jargon ban list. |
|
|
51
|
+
| `business-writing` | BLUF first line, explicit ask + deadline, buzzword ban list. |
|
|
52
|
+
| `corporate-communication` | News first, reader impact named, zero euphemism. |
|
|
53
|
+
| `gov-uk-style` | GOV.UK guide. Keyword-first headings, ≤5-sentence paragraphs. |
|
|
54
|
+
| `asd-ste100` | Simplified Technical English. One instruction per sentence, no idioms. |
|
|
55
|
+
| `google-dev-docs` | Google style. Active voice, present tense, verb-first headings. |
|
|
56
|
+
| `journalism-ap` | AP Stylebook. Attribution, number rules, zero editorializing. |
|
|
45
57
|
|
|
46
|
-
|
|
58
|
+
### Voices — characters, rate-limited against caricature
|
|
59
|
+
|
|
60
|
+
`ted-lasso` · `jack-sparrow` · `shrek` · `yoda` · `winnie-the-pooh` · `paddington` · `bob-ross`
|
|
61
|
+
|
|
62
|
+
## MCP server — unlimited skills, live from GitHub
|
|
47
63
|
|
|
48
|
-
|
|
64
|
+
```bash
|
|
65
|
+
uvx writing-skills-mcp
|
|
66
|
+
```
|
|
49
67
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
68
|
+
The plugin ships 14 skills statically. The MCP server is the living registry
|
|
69
|
+
on top: it discovers styles from the full catalog on GitHub (`search_styles`),
|
|
70
|
+
returns any skill's full `SKILL.md` (`get_skill`), and installs it into a
|
|
71
|
+
harness skills directory (`install_skill`). A new skill is just a commit —
|
|
72
|
+
no package update, no re-install, at any scale.
|
|
54
73
|
|
|
55
|
-
|
|
56
|
-
|
|
74
|
+
```bash
|
|
75
|
+
uvx --from writing-skills writing-skills-mcp
|
|
76
|
+
```
|
|
57
77
|
|
|
58
78
|
## Contribute
|
|
59
79
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
80
|
+
Copy [template/SKILL.md](template/SKILL.md), fill it, run
|
|
81
|
+
`python3 scripts/validate_skills.py`. CI enforces the contract — see
|
|
82
|
+
[CONTRIBUTING.md](CONTRIBUTING.md).
|
|
63
83
|
|
|
64
84
|
## License
|
|
65
85
|
|
|
66
|
-
MIT — [Surendran B](https://github.com/surendranb)
|
|
86
|
+
MIT — [Surendran B](https://github.com/surendranb)
|