ericrisco/rsc-harness / skills/technical-writing
technical-writing
VerifiedUse when writing or fixing user-facing technical docs — a README, a getting-started tutorial, a how-to guide, or API/CLI/config reference — especially when a page tries to teach, explain and enumerate at once, a tutorial branches, a reference is padded with opinions, a README reads like a sales pitch, samples are stale, or weasel words have crept in. NOT an SEO blog article (that is `article-writing`), NOT the content calendar or pipeline (that is `content-engine`).
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 11.7 KB |
| evals/README.md | markdown | 824 B |
| evals/cases.yaml | config | 3.6 KB |
| references/diataxis-modes.md | markdown | 4.1 KB |
| references/vale-starter.md | markdown | 2.2 KB |
| scripts/verify.shexecutable | script | 2.6 KB |
scripts/verify.sh
View on GitHub#!/usr/bin/env bash
#
# verify.sh — structural + prose-banlist lint for the technical-writing skill.
#
# Usage:
# scripts/verify.sh # structure check of the skill itself
# scripts/verify.sh path/to/doc.md # also lint a produced doc against the banlist
#
# Read-only. It never edits a file. This mirrors the Vale gate the skill
# preaches, using pure grep so it needs no dependencies. It lints PHRASING
# and STRUCTURE, not whether the writing is good — that is the capability
# eval's job.
#
# Exit 0 = clean (or nothing to lint). Exit 1 = a banned term in the target
# doc, or a missing required reference file. Empty/clean targets never fail.
set -u
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
SKILL_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
fail=0
# --- 1. Structure: the two references the skill points to must exist. -------
for ref in references/diataxis-modes.md references/vale-starter.md; do
if [ -f "$SKILL_DIR/$ref" ]; then
echo "ok present: $ref"
else
echo "FAIL missing: $ref"
fail=1
fi
done
# --- 2. Structure: SKILL.md must carry the required sections. ---------------
SKILL_MD="$SKILL_DIR/SKILL.md"
if [ -f "$SKILL_MD" ]; then
for heading in "## Anti-patterns" "## Before you ship"; do
if grep -qF "$heading" "$SKILL_MD"; then
echo "ok section: $heading"
else
echo "FAIL section missing in SKILL.md: $heading"
fail=1
fi
done
else
echo "FAIL missing: SKILL.md"
fail=1
fi
# --- 3. Banlist: only applied to a produced doc passed as $1. ---------------
# The skill's own files document the banned words as examples, so we do NOT
# lint them — we lint the doc the agent ships. A whole-word, case-insensitive
# grep keeps it dependency-free.
BANNED='simply|just|easily|effortless|effortlessly|seamless|seamlessly|blazing-fast|blazing fast|supercharge|leverage|utilize|in order to'
TARGET="${1:-}"
if [ -z "$TARGET" ]; then
echo "note no doc path given — skipping banlist (structure-only run)."
elif [ ! -f "$TARGET" ]; then
echo "note '$TARGET' is not a file — nothing to lint. PASS"
elif [ ! -s "$TARGET" ]; then
echo "note '$TARGET' is empty — nothing to lint. PASS"
else
# -E extended regex, -i case-insensitive, -w-ish via word boundaries in -E,
# -n for line numbers. Banned terms inside the banlist file would false-fail,
# but we never pass the skill's own files here.
hits="$(grep -Ein "\b(${BANNED})\b" "$TARGET" || true)"
if [ -n "$hits" ]; then
echo "FAIL banned terms in $TARGET:"
echo "$hits"
fail=1
else
echo "ok banlist clean: $TARGET"
fi
fi
if [ "$fail" -eq 0 ]; then
echo "PASS"
exit 0
fi
echo "FAILED"
exit 1
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deployment | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |