Start / Skills / Entwickler-Produktivität / Writing for Agents
Entwickler-Produktivität

Writing for Agents

Matt PocockMITSprache des Skills: Englisch
Lizenz geprüftKeine Skripte
DemoEchter Lauf · claude-opus-5-5 · Oktober 2026
Can you improve this CLAUDE.md for our repo? Agents keep ignoring parts of it. ```markdown # Project Guidelines This is a Next.js 15 app using the App Router with TypeScript. We use pnpm as our package manager. The scripts are in package.json. ## Important Rules - Please always make sure to be very careful and thorough when making changes. - Don't use npm or yarn. Don't use npm or yarn under any circumstances, always use pnpm. - Never ever use the `any` type. - Run `pnpm lint` and `pnpm test` before you finish. - Don't put business logic in React components. - Make sure you write good code that follows best practices. ## Database We use Prisma with PostgreSQL. The schema is at prisma/schema.prisma. When you change the schema you need to run `pnpm prisma migrate dev --name <name>` and you also need to run `pnpm prisma generate` afterwards, otherwise the types will be out of date and things won't compile. Don't forget to run prisma generate!! ## Testing We use Vitest. Tests live next to the code in `*.test.ts` files. Run `pnpm test`. Please don't forget to run tests before finishing. ## Style Use Tailwind for styling. Don't write CSS files. Don't use inline styles. Don't use styled-components. ```
Skill: writing-for-agents

The main problem is that the important rules are hard to spot among filler. Here's a rewrite:

# Project Guidelines

Next.js 15 (App Router) + TypeScript, managed with **pnpm**. Scripts are in `package.json`.

## Rules

- Run every package and script command through `pnpm` (`pnpm add`, `pnpm dlx`, `pnpm <script>`). The lockfile is `pnpm-lock.yaml`, and running another package manager corrupts it.
- Use precise types everywhere. For data whose shape you don't know yet, use `unknown` and narrow it with type guards or a schema. Never use `any`.
- Keep React components presentational. Put business logic in <!-- TODO: e.g. `src/lib/` or `src/server/` --> and call it from the component.
- Style with Tailwind utility classes only.

## Database (Prisma + PostgreSQL)

After any edit to `prisma/schema.prisma`, run both commands, in this order:

1. `pnpm prisma migrate dev --name <descriptive_name>`
2. `pnpm prisma generate`

If you skip step 2, the generated types go stale and the build fails in ways that are hard to trace back.

## Testing

Vitest. Put each test next to its source file as `<name>.test.ts`.

## Done means

You're finished only when both commands pass with zero errors on your final change:

- `pnpm lint`
- `pnpm test`

What I changed and why:

  1. Cut lines that don't change behavior. "Be careful and thorough" and "write good code that follows best practices" are things the agent already tries to do. They make the file longer and draw attention away from the rules that matter.
  2. Gave each rule one home. "Run tests" appeared twice and "use pnpm" was said twice in one bullet. When an instruction is repeated, it's hard to tell how important it is compared with the rest. Lint and test now live in a single Done means section at the end, where the agent checks whether it's finished.
  3. Said what to do, not just what to avoid. Rules like "Don't use npm or yarn", "Never use any", and "Don't write CSS / inline / styled-components" put the banned thing front and center. Each rule now names what to use instead (pnpm, unknown + narrowing, Tailwind classes). I kept "Never use any" as a hard limit, paired with the alternative.
  4. Added the reasons agents can't figure out on their own. The lockfile damage and the stale Prisma types are why those rules exist. A rule that comes with its reason is less likely to be dropped as optional.
  5. Turned the Prisma steps into a numbered list instead of a paragraph ending in "Don't forget!!".
  6. Made "finished" checkable. "Run lint and test" became "both pass with zero errors". Before, an agent could run the tests, see failures, and still stop.

One thing for you to fill in: "Don't put business logic in components" probably gets ignored because the agent doesn't know where that logic should go. Replace the TODO with your real directory, such as src/lib/ or server actions in app/**/actions.ts.

Optional: if agents still use npm or skip lint, put it in a hook instead of the doc. A PreToolUse hook can block npm/yarn commands, and a Stop hook can run pnpm lint && pnpm test. I can set either one up with /update-config if you want.

Real run recorded with claude-code / claude-opus-5-5. Output is shown verbatim, unmodified.

Was es macht

Ein Leitfaden zum Schreiben jedes Dokuments, das ein Agent verarbeitet. Die Prämisse: Dieselben wenigen Hebel machen einen Skill, eine CLAUDE.md oder ein verlinktes Dokument vorhersehbar, weil der Agent bei jedem Lauf denselben Prozess durchlaufen soll.

So funktioniert es

  1. Kontext-Zeiger: Die Formulierung einer Skill-Beschreibung oder einer Zeile in AGENTS.md entscheidet, wann und wie zuverlässig der Agent das Material dahinter erreicht.
  2. Die zwei Lasten: Jede Ergänzung kostet entweder Kontext (immer geladener Text) oder die Aufmerksamkeit des Menschen (wissen, welche Dokumente es gibt).
  3. Informationshierarchie: Schritte in die Hauptdatei, Referenzmaterial hinter Zeiger, und keine Aufblähung.
  4. Abschlusskriterien: Jeder Schritt endet an einer prüfbaren Bedingung, damit der Agent nicht zu früh aufhört.
  5. Ausdünnen: Eine Quelle pro Bedeutung, Sätze streichen, die das Modell ohnehin befolgt, und das Zielverhalten nennen statt das unerwünschte zu verbieten.
  6. Eine zweite Datei behandelt Skill-Spezifisches: Frontmatter, nur vom Nutzer aufrufbar oder vom Modell aufrufbar, Router-Skills.

Geeignet für

Einen Skill, eine CLAUDE.md oder AGENTS.md schreiben oder straffen.

Gut zu wissen

In unserem Test schrieb es eine Beispiel-CLAUDE.md um, erklärte jede Änderung und ließ ein TODO stehen, statt einen Verzeichnisnamen zu erfinden.

Hinweise & Risiken

Reine Anweisungsdateien: keine Skripte, kein Netzwerkzugriff. Wenn du es bittest, eine Datei zu bearbeiten, kann der Agent in diese Datei in deinem Projekt schreiben. Das Paket enthält außerdem die MIT-Lizenz (LICENSE) des Original-Repositorys und agents/openai.yaml (Anzeigename für Codex).