@arkone_ai/handbook-section 1.0.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 +29 -0
- package/install/install.js +38 -0
- package/package.json +27 -0
- package/skill.md +213 -0
package/README.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# @arkone_ai/handbook-section
|
|
2
|
+
|
|
3
|
+
A [Claude Code](https://claude.ai/code) skill that writes or rewrites employee handbook sections in plain, approachable language.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @arkone_ai/handbook-section
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
In any Claude Code session:
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
/handbook-section
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## What it does
|
|
20
|
+
|
|
21
|
+
- Writes a new handbook section or rewrites an existing one for clarity
|
|
22
|
+
- Matches the tone and style of your existing handbook if you provide a reference
|
|
23
|
+
- Uses plain language with TL;DR boxes, examples, and scannable formatting
|
|
24
|
+
- Flags compliance-sensitive content for legal review
|
|
25
|
+
- Outputs as PDF, DOCX, or Markdown
|
|
26
|
+
|
|
27
|
+
## License
|
|
28
|
+
|
|
29
|
+
MIT
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
import { copyFileSync, mkdirSync, existsSync } from 'fs';
|
|
4
|
+
import { join } from 'path';
|
|
5
|
+
import { homedir } from 'os';
|
|
6
|
+
|
|
7
|
+
const root = join(import.meta.dirname, '..');
|
|
8
|
+
const home = homedir();
|
|
9
|
+
|
|
10
|
+
const agents = [
|
|
11
|
+
{ name: 'Claude Code', dir: join(home, '.claude', 'skills') },
|
|
12
|
+
{ name: 'Codex', dir: join(home, '.codex', 'skills') },
|
|
13
|
+
{ name: 'Kiro', dir: join(home, '.kiro', 'skills') },
|
|
14
|
+
];
|
|
15
|
+
|
|
16
|
+
const files = [
|
|
17
|
+
{ src: join(root, 'skill.md'), dest: 'handbook-section.md' },
|
|
18
|
+
];
|
|
19
|
+
|
|
20
|
+
let installed = 0;
|
|
21
|
+
for (const agent of agents) {
|
|
22
|
+
if (!existsSync(agent.dir)) continue;
|
|
23
|
+
for (const file of files) {
|
|
24
|
+
copyFileSync(file.src, join(agent.dir, file.dest));
|
|
25
|
+
}
|
|
26
|
+
console.log(`✓ ${agent.name}: ${agent.dir}`);
|
|
27
|
+
installed++;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
if (installed === 0) {
|
|
31
|
+
mkdirSync(agents[0].dir, { recursive: true });
|
|
32
|
+
for (const file of files) {
|
|
33
|
+
copyFileSync(file.src, join(agents[0].dir, file.dest));
|
|
34
|
+
}
|
|
35
|
+
console.log(`✓ Claude Code: ${agents[0].dir}`);
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
console.log('\nUse /handbook-section in any supported AI session.');
|
package/package.json
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@arkone_ai/handbook-section",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Claude Code skill: write or rewrite employee handbook sections in plain language",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"scripts": {
|
|
7
|
+
"postinstall": "node install/install.js"
|
|
8
|
+
},
|
|
9
|
+
"bin": {
|
|
10
|
+
"handbook-section": "install/install.js"
|
|
11
|
+
},
|
|
12
|
+
"files": [
|
|
13
|
+
"skill.md",
|
|
14
|
+
"install/"
|
|
15
|
+
],
|
|
16
|
+
"keywords": [
|
|
17
|
+
"claude",
|
|
18
|
+
"claude-code",
|
|
19
|
+
"arkone",
|
|
20
|
+
"hr-ops",
|
|
21
|
+
"handbook-section"
|
|
22
|
+
],
|
|
23
|
+
"license": "MIT",
|
|
24
|
+
"engines": {
|
|
25
|
+
"node": ">=18"
|
|
26
|
+
}
|
|
27
|
+
}
|
package/skill.md
ADDED
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: handbook-section
|
|
3
|
+
description: "Write or rewrite an employee handbook section in plain language, output as branded PDF/DOCX. Use this skill when: 'write handbook section', 'update handbook', 'rewrite handbook chapter', 'add to employee handbook', 'handbook entry'. Also trigger for: 'employee guide section', 'staff handbook', 'company handbook'."
|
|
4
|
+
license: MIT
|
|
5
|
+
compatibility: Designed for Claude Code
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Skill: handbook-section
|
|
9
|
+
|
|
10
|
+
Write or rewrite an employee handbook section in plain, approachable language. Matches existing handbook style if a reference is provided.
|
|
11
|
+
|
|
12
|
+
## When to use
|
|
13
|
+
|
|
14
|
+
- User wants to write a new section for their employee handbook
|
|
15
|
+
- User wants to rewrite an existing section to be clearer or more current
|
|
16
|
+
- User provides a topic and wants handbook-ready content
|
|
17
|
+
|
|
18
|
+
## Step 1: Gather inputs
|
|
19
|
+
|
|
20
|
+
### Required
|
|
21
|
+
|
|
22
|
+
| Field | Example |
|
|
23
|
+
|---|---|
|
|
24
|
+
| Section topic | Welcome & Company Overview, Benefits, Time Off, Workplace Conduct, Safety, IT & Security, etc. |
|
|
25
|
+
| Company specifics | Key facts, rules, or details unique to this company for this topic |
|
|
26
|
+
|
|
27
|
+
### Optional
|
|
28
|
+
|
|
29
|
+
| Field | Default | Purpose |
|
|
30
|
+
|---|---|---|
|
|
31
|
+
| Company name | Ask user | Used in content and branding |
|
|
32
|
+
| Existing handbook | — | Path to current handbook PDF/DOCX — used to match tone, style, formatting |
|
|
33
|
+
| Existing section | — | Path or text of the section being rewritten |
|
|
34
|
+
| Target audience | All employees | New hires, managers, contractors, specific department |
|
|
35
|
+
| Tone | Friendly-professional | `friendly` (conversational, warm), `professional` (balanced), `formal` (corporate) |
|
|
36
|
+
| Handbook style | — | E.g., "We use 'you' not 'employees'", "Include icons", "Each section has a TL;DR" |
|
|
37
|
+
| Jurisdiction | US (general) | For compliance-sensitive sections |
|
|
38
|
+
| Output format | PDF | `pdf`, `docx`, `md` |
|
|
39
|
+
|
|
40
|
+
### Brand assets (optional)
|
|
41
|
+
|
|
42
|
+
Check for brand config at these locations (in order):
|
|
43
|
+
1. Path provided by user
|
|
44
|
+
2. `./brand-config.json` in current directory
|
|
45
|
+
3. `~/.claude/hr-brand.json` global config
|
|
46
|
+
|
|
47
|
+
## Step 2: Determine the section type
|
|
48
|
+
|
|
49
|
+
Handbooks cover a wide range of topics. Identify which category the requested section falls into and use the appropriate structure.
|
|
50
|
+
|
|
51
|
+
### Common handbook sections and their structure
|
|
52
|
+
|
|
53
|
+
| Section | Typical content | Key elements |
|
|
54
|
+
|---|---|---|
|
|
55
|
+
| **Welcome / About Us** | Company mission, values, history, culture | Warm tone, storytelling, no legalese |
|
|
56
|
+
| **Employment Basics** | At-will notice, employment types, equal opportunity | Legal disclaimers required |
|
|
57
|
+
| **Workplace Conduct** | Expected behavior, dress code, attendance, substance policy | Clear dos and don'ts, examples |
|
|
58
|
+
| **Anti-Harassment & Discrimination** | Protected classes, reporting, investigation | Must include legal notices, reporting channels |
|
|
59
|
+
| **Compensation & Pay** | Pay schedule, overtime, deductions, direct deposit | Compliance with FLSA, state wage laws |
|
|
60
|
+
| **Benefits** | Health, dental, vision, 401k, life insurance, perks | Eligibility, enrollment, summary of plans |
|
|
61
|
+
| **Time Off & Leave** | PTO, sick leave, holidays, parental leave, bereavement | Accrual, request process, carryover |
|
|
62
|
+
| **Remote & Hybrid Work** | Eligibility, expectations, equipment, communication | Practical guidance, not just rules |
|
|
63
|
+
| **IT & Security** | Acceptable use, passwords, devices, data handling | Clear rules, consequences |
|
|
64
|
+
| **Safety & Emergency** | Workplace safety, emergency procedures, incident reporting | OSHA requirements, evacuation plan |
|
|
65
|
+
| **Performance & Growth** | Review cycle, feedback, promotions, training | Encouraging tone, growth-oriented |
|
|
66
|
+
| **Leaving the Company** | Resignation, termination, exit process, final pay | Legal requirements, practical steps |
|
|
67
|
+
|
|
68
|
+
## Step 3: Analyze existing handbook (if provided)
|
|
69
|
+
|
|
70
|
+
If the user provides their current handbook or a reference:
|
|
71
|
+
|
|
72
|
+
1. **Read the document** — extract text from PDF/DOCX
|
|
73
|
+
2. **Identify the style**:
|
|
74
|
+
- Person: "you" vs "employees" vs "team members"
|
|
75
|
+
- Tone: casual, friendly-professional, formal, legal
|
|
76
|
+
- Structure: paragraphs vs bullets vs numbered lists
|
|
77
|
+
- Special elements: TL;DR boxes, icons, callouts, FAQ format
|
|
78
|
+
- Length: brief (1 page) vs detailed (3-5 pages)
|
|
79
|
+
3. **Match the style** in the new/rewritten section
|
|
80
|
+
4. **Check for cross-references** — if other sections reference this one, maintain consistency
|
|
81
|
+
|
|
82
|
+
If rewriting an existing section:
|
|
83
|
+
1. Read the current version
|
|
84
|
+
2. Identify what's outdated, unclear, or missing
|
|
85
|
+
3. Preserve any company-specific details that are still accurate
|
|
86
|
+
4. Note changes in the output summary
|
|
87
|
+
|
|
88
|
+
## Step 4: Write the section
|
|
89
|
+
|
|
90
|
+
### Writing rules
|
|
91
|
+
|
|
92
|
+
1. **Write for the reader, not the lawyer** — employees should understand this without a law degree
|
|
93
|
+
2. **Use "you" and "we"** — unless the existing handbook uses a different convention
|
|
94
|
+
3. **Lead with the takeaway** — what does the employee need to know? Say it first.
|
|
95
|
+
4. **Keep sentences short** — aim for 15-20 words per sentence
|
|
96
|
+
5. **One idea per paragraph** — if a paragraph covers two topics, split it
|
|
97
|
+
6. **Use headers liberally** — employees scan, they don't read cover-to-cover
|
|
98
|
+
7. **Include practical examples** — "For example, if you need to take a sick day..."
|
|
99
|
+
8. **Add a TL;DR or key points box** at the top of longer sections
|
|
100
|
+
9. **Avoid double negatives** — "You may not refuse to..." → "You must..."
|
|
101
|
+
10. **Be honest about ambiguity** — "Talk to your manager" is better than a vague rule
|
|
102
|
+
|
|
103
|
+
### Section structure
|
|
104
|
+
|
|
105
|
+
Every handbook section should follow this pattern:
|
|
106
|
+
|
|
107
|
+
```
|
|
108
|
+
[Section Title]
|
|
109
|
+
|
|
110
|
+
[TL;DR / Key Points box — 3-5 bullet summary]
|
|
111
|
+
|
|
112
|
+
[Overview — 1-2 paragraphs: what this section covers and why it matters]
|
|
113
|
+
|
|
114
|
+
[Main content — organized by subtopic with clear headers]
|
|
115
|
+
- Rules and expectations
|
|
116
|
+
- How-to / procedures
|
|
117
|
+
- Examples where helpful
|
|
118
|
+
- FAQs if the topic is commonly misunderstood
|
|
119
|
+
|
|
120
|
+
[Where to go for help — who to contact, links, resources]
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Compliance check
|
|
124
|
+
|
|
125
|
+
For compliance-sensitive sections:
|
|
126
|
+
- Include required legal notices appropriate to the jurisdiction
|
|
127
|
+
- Add "where local law provides greater benefits, local law applies" where relevant
|
|
128
|
+
- Flag any content that should be reviewed by legal counsel with: `⚠️ LEGAL REVIEW: [reason]`
|
|
129
|
+
- Never present the handbook as a contract — include appropriate disclaimers
|
|
130
|
+
|
|
131
|
+
### Tone calibration
|
|
132
|
+
|
|
133
|
+
| Tone setting | Characteristics | Example |
|
|
134
|
+
|---|---|---|
|
|
135
|
+
| `friendly` | Conversational, uses contractions, warm, may use humor | "We get it — life happens. Here's how time off works." |
|
|
136
|
+
| `professional` | Clear and approachable but not casual, balanced | "Our time off policy is designed to support work-life balance." |
|
|
137
|
+
| `formal` | Corporate, no contractions, structured | "The Company provides paid time off to eligible employees." |
|
|
138
|
+
|
|
139
|
+
## Step 5: Generate the document
|
|
140
|
+
|
|
141
|
+
### PDF (default)
|
|
142
|
+
|
|
143
|
+
1. Create HTML with inline CSS
|
|
144
|
+
2. Apply brand assets:
|
|
145
|
+
- Logo in header
|
|
146
|
+
- Primary color for section headings
|
|
147
|
+
- Secondary color for subheadings and callout boxes
|
|
148
|
+
- TL;DR boxes with accent color background
|
|
149
|
+
- Footer with company name and page numbers
|
|
150
|
+
3. Style to look like a handbook page (not a policy document — warmer, more readable)
|
|
151
|
+
4. Convert via `npx puppeteer`, `wkhtmltopdf`, or `prince`
|
|
152
|
+
|
|
153
|
+
### DOCX (if requested)
|
|
154
|
+
|
|
155
|
+
1. Use `python-docx` or Node `docx` package
|
|
156
|
+
2. Apply Heading 1/2/3 styles for easy TOC integration
|
|
157
|
+
3. Include callout boxes as shaded text blocks
|
|
158
|
+
|
|
159
|
+
### Markdown (if requested)
|
|
160
|
+
|
|
161
|
+
1. Output as `.md`
|
|
162
|
+
2. Use blockquotes for TL;DR boxes
|
|
163
|
+
3. Standard heading hierarchy
|
|
164
|
+
|
|
165
|
+
### Output file
|
|
166
|
+
|
|
167
|
+
Save to: `./handbook-<topic-slug>-<date>.pdf` (or `.docx` / `.md`)
|
|
168
|
+
|
|
169
|
+
## Step 6: Output summary
|
|
170
|
+
|
|
171
|
+
```
|
|
172
|
+
✅ Handbook Section Generated
|
|
173
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
174
|
+
Topic: Time Off & Leave
|
|
175
|
+
Company: Acme Corp
|
|
176
|
+
Tone: Friendly-professional
|
|
177
|
+
Mode: New section (or: Rewrite of existing)
|
|
178
|
+
Length: ~3 pages
|
|
179
|
+
Style match: Matched existing handbook tone ✓ (or: No reference provided)
|
|
180
|
+
Legal flags: 2 items flagged for review
|
|
181
|
+
File: ./handbook-time-off-2026-03-23.pdf
|
|
182
|
+
|
|
183
|
+
⚠️ Legal review recommended:
|
|
184
|
+
- Section 3.2: FMLA eligibility criteria — verify with counsel
|
|
185
|
+
- Section 5.1: State-specific leave requirements — confirm for CA, NY, WA
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
## Rewrite mode
|
|
189
|
+
|
|
190
|
+
When the user provides an existing section to rewrite:
|
|
191
|
+
|
|
192
|
+
1. Show a brief diff summary of what changed:
|
|
193
|
+
```
|
|
194
|
+
Changes made:
|
|
195
|
+
✏️ Rewrote opening paragraph for clarity
|
|
196
|
+
➕ Added TL;DR box (was missing)
|
|
197
|
+
✏️ Simplified legalese in section 2.3
|
|
198
|
+
➕ Added 3 practical examples
|
|
199
|
+
🗑️ Removed outdated reference to 2019 policy
|
|
200
|
+
⚠️ Flagged FMLA section for legal review
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
2. Preserve all company-specific details (names, numbers, dates) unless the user explicitly asked to change them
|
|
204
|
+
|
|
205
|
+
## Error handling
|
|
206
|
+
|
|
207
|
+
| Issue | What to do |
|
|
208
|
+
|---|---|
|
|
209
|
+
| Topic is vague | Ask: "Which handbook section? E.g., Benefits, Time Off, Workplace Conduct..." |
|
|
210
|
+
| No company specifics provided | Draft with placeholders: `[COMPANY NAME]`, `[X DAYS]`, `[CONTACT]` — mark clearly |
|
|
211
|
+
| Existing handbook unreadable | Fall back to default tone and structure, warn user |
|
|
212
|
+
| Section conflicts with another section | Flag the conflict, suggest how to resolve |
|
|
213
|
+
| User wants full handbook | Explain this skill does one section at a time; offer to do them sequentially |
|