Agent Skills › softaworks/agent-toolkit › crafting-effective-readmes

crafting-effective-readmes

GitHub

提供README编写、更新和审查的模板与指南，针对不同项目类型（开源、个人等）优化文档结构，确保内容准确并满足目标读者需求。

skills/crafting-effective-readmes/SKILL.md softaworks/agent-toolkit

Trigger Scenarios

编写新项目README 更新现有README内容检查README准确性添加新功能文档说明

Install

npx skills add softaworks/agent-toolkit --skill crafting-effective-readmes -g -y

More Options

Use without installing

npx skills use softaworks/agent-toolkit@crafting-effective-readmes

指定 Agent (Claude Code)

npx skills add softaworks/agent-toolkit --skill crafting-effective-readmes -a claude-code -g -y

安装 repo 全部 skill

npx skills add softaworks/agent-toolkit --all -g -y

预览 repo 内 skill

npx skills add softaworks/agent-toolkit --list

SKILL.md

Frontmatter

{
    "name": "crafting-effective-readmes",
    "description": "Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type."
}

Crafting Effective READMEs

Overview

READMEs answer questions your audience will have. Different audiences need different information - a contributor to an OSS project needs different context than future-you opening a config folder.

Always ask: Who will read this, and what do they need to know?

Process

Step 1: Identify the Task

Ask: "What README task are you working on?"

Task	When
Creating	New project, no README yet
Adding	Need to document something new
Updating	Capabilities changed, content is stale
Reviewing	Checking if README is still accurate

Step 2: Task-Specific Questions

Creating initial README:

What type of project? (see Project Types below)
What problem does this solve in one sentence?
What's the quickest path to "it works"?
Anything notable to highlight?

Adding a section:

What needs documenting?
Where should it go in the existing structure?
Who needs this info most?

Updating existing content:

What changed?
Read current README, identify stale sections
Propose specific edits

Reviewing/refreshing:

Read current README
Check against actual project state (package.json, main files, etc.)
Flag outdated sections
Update "Last reviewed" date if present

Step 3: Always Ask

After drafting, ask: "Anything else to highlight or include that I might have missed?"

Project Types

Type	Audience	Key Sections	Template
Open Source	Contributors, users worldwide	Install, Usage, Contributing, License	`templates/oss.md`
Personal	Future you, portfolio viewers	What it does, Tech stack, Learnings	`templates/personal.md`
Internal	Teammates, new hires	Setup, Architecture, Runbooks	`templates/internal.md`
Config	Future you (confused)	What's here, Why, How to extend, Gotchas	`templates/xdg-config.md`