Metadata-Version: 2.5
Name: writing-skills
Version: 0.1.0
Summary: Procedural writing-style skills for AI agents — official frameworks, not vibes.
Project-URL: Homepage, https://github.com/surendranb/writing-skills
Project-URL: Repository, https://github.com/surendranb/writing-skills
Author: Surendran B
License: MIT
License-File: LICENSE
Keywords: agent-skills,claude-code,copywriting,opencode,voice,writing,writing-style
Requires-Python: >=3.9
Description-Content-Type: text/markdown

<p align="center">
  <img src="logo.svg" alt="Writing Skills Logo" width="120" />
</p>

# Writing Skills 🖋️

[![GitHub stars](https://img.shields.io/github/stars/surendranb/writing-skills?style=social)](https://github.com/surendranb/writing-skills/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/surendranb/writing-skills?style=social)](https://github.com/surendranb/writing-skills/network/members)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**Procedural writing-style skills for AI agents — official frameworks, not vibes.**

This is not a collection of writing "personas." It is a set of audited writing
frameworks — plain language, business writing, corporate communication, GOV.UK,
AP style, STE-100, developer documentation — each encoded as a `SKILL.md` with
numbered mechanics and a **verifiable checklist** the agent must pass. **Compatible
with any agent that reads SKILL.md** (opencode, Claude Code, Codex, Gemini).

---

## 🎯 Authoritative Skills

| Skill Name | What It Enforces |
| :--- | :--- |
| **`writing-skills:plain-language`** | Plain Writing Act clarity. Sentence ≤25 words, passive ≤10%, Flesch ≥60, jargon ban list. |
| **`writing-skills:business-writing`** | Executive-grade comms. BLUF in the first line, explicit ask + deadline, buzzword ban list. |
| **`writing-skills:corporate-communication`** | Company announcements & change comms. News first, reader impact explicit, zero euphemism. |
| **`writing-skills:gov-uk-style`** | Public-sector readability. Keyword-first headings, ≤25-word sentences, ≤5-sentence paragraphs. |
| **`writing-skills:asd-ste100`** | Safety-critical technical prose. One instruction per sentence, controlled vocabulary, no idioms. |
| **`writing-skills:google-dev-docs`** | Developer documentation. Active voice, present tense, verb-first headings, runnable examples. |
| **`writing-skills:journalism-ap`** | Factual reporting. AP attribution & number rules, zero editorializing. |

**Fun tier (positive-only voices, v1):** `ted-lasso` · `jack-sparrow` · `shrek` · `yoda` · `winnie-the-pooh` · `paddington` · `bob-ross`

---

## 🚀 Getting Started

### 1. Install (one line)

```bash
npx skills add writing-skills
```

Or clone:

```bash
git clone https://github.com/surendranb/writing-skills.git
```

### 2. Configuration (Universal AI Agent)

**Claude Code / Codex (≥ 0.147) / Kiro** — the root `plugin.json` (Agent Plugins 1.0.0) is discovered natively. No config needed.

**opencode** — add to `opencode.json` (native manifest support pending — [opencode#40993](https://github.com/anomalyco/opencode/issues/40993)):

```json
{
  "skills": { "paths": ["/path/to/writing-skills/skills"] }
}
```

### 3. Use It

Ask for a style and the skill loads automatically: *"rewrite this in plain language"*,
*"make this a BLUF business update"*, *"write the press release in AP style"*.

---

## 🧠 Why Agents & Writers Prefer This

- **Procedural over vibes:** numbered mechanics, do-not lists, and before/after transformations — not "sound more professional."
- **Verifiable, not aspirational:** every official framework ships a concrete `Verify` checklist (sentence caps, passive-voice scans, ban lists, readability targets) the agent must pass before delivering.
- **Zero security surface:** pure SKILL.md instruction files. No hooks, no code execution, no network calls.
- **Officially derived:** STE-100 (ASD), GOV.UK style, AP Stylebook, Plain Writing Act 2010, Google developer docs style — distilled into executable rules.
- **Portable by design:** Agent Plugins 1.0.0 package that ships the same files to any SKILL.md-compliant client.

---

## 🛠️ Roadmap

- Tier 2 voice craft: Scott Adams, Hemingway, Orwell, Zinsser
- More characters: Mr. Rogers, Dumbledore, Mary Poppins, Baymax, Olaf
- npm + PyPI publish for 1-line installs
- Registry namespace: npm `writing-skills` · PyPI `writing-skills`

---

## 🔒 Privacy & Telemetry

**None.** This package is a set of static markdown files. It sends no telemetry,
collects no data, and executes no code. The skills load into your agent's context
and stay there.

---

## 📄 License & Author

Developed by **Surendran B** under the **MIT License**.

GitHub: [surendranb/writing-skills](https://github.com/surendranb/writing-skills)