crafting-effective-readmes

Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.

1.12x

Quality

83%

Does it follow best practices?

Impact

92%

1.12x

Average score across 3 eval scenarios

Securityby

Passed

No known issues

Evaluation results

100%

Write a README for an Open Source CLI Tool

OSS README template and structure

Criteria

Without context

With context

Badges present

100%

About/description section

100%

Features section

100%

Installation steps present

100%

Requirements listed

100%

Code example in Usage

100%

Contributing section

100%

Development setup in Contributing

100%

License section

100%

Structured formatting

100%

Name and one-line description

100%

No 'What's Here' section

100%

No 'Last Reviewed' date

100%

78%

Document an Internal Notification Microservice

Internal service README template and structure

Criteria

Without context

With context

Team/on-call info

100%

Overview with dependencies

100%

Environment variables table

100%

Local development setup

100%

Architecture section

100%

88%

Key files table

Runbooks section

44%

100%

Troubleshooting section

100%

Gotchas/Notes section

25%

No badges

100%

Deployment environments table

14%

Structured formatting

100%

20%

Document a Neovim Config Directory

Config directory README template and sections

Criteria

Without context

With context

Last reviewed date

60%

100%

What's Here table

58%

100%

Why This Setup section

100%

How to Extend section

100%

Gotchas section

100%

Dependencies section

100%

No badges

100%

No Contributing section

100%

Name and one-line description

87%

100%

Structured formatting

100%

Usage/examples present

100%

Repository: softaworks/agent-toolkit
Commit: 3027f20

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

Table of Contents

Write a README for an Open Source CLI Tool Document an Internal Notification Microservice Document a Neovim Config Directory

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.