docs-that-work

Project documentation guidelines. Use when asked to "write documentation", "create a CLAUDE.md", "write a README", "document this project", "improve documentation", or when creating/updating CLAUDE.md or README.md files.

1.11x

Quality

—

Does it follow best practices?

Impact

97%

1.11x

Average score across 3 eval scenarios

Securityby

Passed

No known issues

Evaluation results

98%

24%

Document a New Payment Service

CLAUDE.md and README creation with discoverability filtering

Criteria

Without context

With context

CLAUDE.md excludes commands

100%

CLAUDE.md excludes env var names

57%

100%

CLAUDE.md excludes directory trees

71%

100%

CLAUDE.md idempotency constraint

100%

CLAUDE.md webhook key gotcha

100%

CLAUDE.md process-boundary constraint

100%

CLAUDE.md size

71%

100%

CLAUDE.md purpose section

100%

README has executable commands

100%

README human onboarding structure

100%

No duplication between files

12%

75%

Audit excludes discoverable items

42%

100%

Audit includes non-discoverable items

100%

95%

-2%

Triage Overgrown Documentation in a Monorepo

Bloated CLAUDE.md audit and refactor in monorepo

Criteria

Without context

With context

Root CLAUDE.md strips directory tree

57%

100%

Root CLAUDE.md strips commands

100%

Root CLAUDE.md strips dependencies

100%

Root CLAUDE.md strips env var names

100%

Root CLAUDE.md strips types

100%

Root CLAUDE.md preserves event naming convention

100%

Root CLAUDE.md size

100%

Service CLAUDE.md strips discoverable content

100%

85%

Service CLAUDE.md append-only constraint

100%

Service CLAUDE.md Kafka integration test gotcha

100%

No root content repeated in service

100%

55%

Refactor notes classify removals correctly

100%

Write a README for an Open-Source Validation Library

README for open-source library with grey-box interface focus

Criteria

Without context

With context

README has install command

100%

README has run/test command

100%

README documents public API

100%

README excludes internal internals

91%

100%

README has prerequisites

100%

README human onboarding focus

100%

README does not duplicate CONTRIBUTING.md

100%

README executable commands

100%

Design notes: interface vs implementation

100%

Design notes: human onboarding reasoning

100%

README does not contain directory tree

100%

README does not list all types/interfaces

100%

Repository: provectus/awos-recruitment
Commit: 4596913

Evaluated: 14 days ago
Agent: Claude Code
Model: Claude Sonnet 4.6

Table of Contents

Document a New Payment Service Triage Overgrown Documentation in a Monorepo Write a README for an Open-Source Validation Library

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.