Sharp Writing

Regler för skarp, koncis prosa i dokumentation, READMEs och agentsfärdigheter

av paleo · paleo/alignfirst

Testad · Fungerar ★ 9.2/10

Sharp Writing — Regler för skarp, koncis prosa i dokumentation, READMEs och agentsfärdigheter

Vad den gör

En enfärdighetsfil med konventioner för att skriva tät, precis prosa och Markdown för både mänskliga och AI-läsare. Utlöses före skrivning av dokumentation, READMEs, instruktioner eller agentsfärdigheter. Reglerna täcker positiv formulering, en-idé-per-mening-struktur, borttagning av upprepande avslutningar och målgruppsspecifik användning av em-dash.

Testrapport

Körde den på en CLI README-intro: den skar ner ett 55-ordigt hypeladdat stycke till 40 ord, tog bort 'powerful/intuitive/essential', och raderade en upprepande avslutande mening som dess 'stop at the last fact'-regel förbjuder, samtidigt som den lade till konkret exit-code-beteende. Enkel självständig SKILL.md utan skript, så inget att bryta eller exfiltrera, och installationskommandot placerade den i en ren HOME rent. Texten praktiserar den koncision den predikar, så dess påståenden matchar observerat beteende.

Testad: 2026-07-18 · Claude Code 2.x (agent harness)

Installation

git clone https://github.com/paleo/alignfirst
mkdir -p ~/.claude/skills
cd alignfirst && cp -r .agents/skills/sharp-writing ~/.claude/skills/sharp-writing

Kommandon och exempelprompter

  • /sharp-writingRegler för skarp, koncis prosa i dokumentation, READMEs och agentsfärdigheter

Skills triggas av vanliga förfrågningar — inga kommandon att memorera. Efter installationen aktiverar prompter som dessa skillen (på engelska):

  • Tighten the prose in this CLI tool's README introduction paragraph.
  • Draft a concise docs page for this API without any filler language.
  • Cut the hype and restate-y closer sentence in this agent skill's body.