crafting-effective-readmes
Use when writing or improving README files.
Skill by wwsun
Install
Works with Claude Code, Claude apps, Codex, Cursor, Gemini CLI, GitHub Copilot, VS Code, OpenCode, Goose, Windsurf. Read the repository before you give any tool access to your data.
npx agentmarket install skill/wwsun-crafting-effective-readmes
Asks which of your tools to add it to (Claude Code, Codex, Cursor, VS Code, Windsurf, Gemini CLI, Claude Desktop) and shows the change first. See https://agentmart.dev/cli.
Get the weekly diff
The weekly diff: one email a week with new agent tools, notable updates and grade changes, plus security alerts for tools you follow. Double opt-in, one-click unsubscribe.
About
Use cases: writing
Reviews
Write a reviewNo reviews yet. Installed it? Reviews come from verified installers only. How reviews work
Permissions: not checked yet.
What's inside
- Skill 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.
- License
- unknown
- Instructions
- 75 lines in SKILL.md · view on GitHub
Files (14)
- README.md
- SKILL.md
- art-of-readme.md · references/
- make-a-readme.md · references/
- standard-readme-example-maximal.md · references/
- standard-readme-example-minimal.md · references/
- standard-readme-spec.md · references/
- section-checklist.md
- style-guide.md
- internal.md · templates/
- oss.md · templates/
- personal.md · templates/
- xdg-config.md · templates/
- using-references.md
The license isn't open source, so the instructions aren't shown here. Read SKILL.md on GitHub
More from wwsun/skills
- 0.494score
daily-progress
wwsun
生成每日/每周工作进展报告。通过 /daily-progress 手动调用，从 git 提交记录中提取所有分支的变更，按类型（feat/fix/refactor 等）分组汇总，每条标注责任人，用 AI 智能总结为面向主管/团队的可读进展报告。支持位置参数：不传参数生成日报，传 week 生成周报。时间范围为前一天…
SkillCFreshness: C★ 1Claude Code +9 - 0.494score
java-web-scaffold
wwsun
初始化 java fullstack 工程（Java 21 + Spring Boot 3 + React 19 + MySQL + Redis）。只在用户明确输入 /java-web-scaffold 时才使用此技能，不要根据任务内容自动推断是否使用此 skill。
SkillCFreshness: C★ 1Claude Code +9 - 0.491score
gitlab-issues
wwsun
自动化整理 GitLab Issues。支持一键执行完整流程：自动为新增 Issue 打标 (tag) 和指派 (assign)，并生成包含新增、优先关注及分类统计的每日汇总报告。支持动态更新配置规则。
SkillCFreshness: C★ 1Claude Code +9 - 0.489score
agent-docs-creator
wwsun
为项目创建、更新和同步实现文档（implementation docs），帮助 Claude Code 等 coding agent 快速理解项目结构与实现细节。文档存储在项目 `agent_docs/` 目录，并在 AGENTS.md 中添加 `@agent_docs/index.md`…
SkillCFreshness: C★ 1Claude Code +9 - 0.489score
repo-explorer
wwsun
深度探索和理解代码仓库的架构、核心模块、设计决策和工程化能力，帮助用户快速建立项目全局认知。 当用户说"帮我了解这个项目"、"这个项目是怎么工作的"、"我刚 clone 了这个仓库"、 "帮我分析这个代码库"、"这个项目的架构是什么"、"入口文件在哪"、"核心模块怎么组织的"、…
SkillCFreshness: C★ 1Claude Code +9 - 0.489score
move-skill
wwsun
将 .Codex/skills 中的技能迁移到 .agents/skills 目录，并在原位置创建软链接，实现跨工具共享。当用户说"把某个 skill 移动到 agents"、"迁移技能"、"共享 skill 到 .agents"、"把 skill 放到 agents 目录"、"sync skill to…
SkillCFreshness: C★ 1Claude Code +9 - 0.462score
grill-me
wwsun
Interview the user relentlessly about a plan or design until reaching shared understanding, resolving each branch of the decision tree.
SkillCFreshness: C★ 1Claude Code +9 - 0.427score
defuddle
wwsun
Extract clean markdown content from web pages using Defuddle CLI, removing clutter and navigation to save tokens.
SkillDFreshness: D★ 1Claude Code +9 - 0.426score
diagram-expert
wwsun
使用 Mermaid、PlantUML、GraphViz 等语言创建技术图表。当用户需要流程图、时序图、架构图、ER 图、甘特图或思维导图时触发。
SkillDFreshness: D★ 1Claude Code +9 - 0.424score
claude-md-expert
wwsun
创建、更新和优化 AGENTS.md 和 CLAUDE.md 配置文件。当用户请求初始化/改进项目配置、添加编码规范、设置 AI 代理规则时触发。项目中同时管理 AGENTS.md（通用 AI 规则）和 CLAUDE.md（Claude 专属配置），如果项目中不存在这两个文件，主动提议为用户同时创建它们。
SkillDFreshness: D★ 1Claude Code +9 - 0.423score
web-security-expert
wwsun
Web 安全专家，基于 OWASP Top 10 2025 提供安全审计、漏洞分析和修复建议。
SkillDFreshness: D★ 1Claude Code +9 - 0.407score
skill-creator
wwsun
Create new skills, modify and improve existing skills, and measure skill performance.
SkillDFreshness: D★ 1Claude Code +9
Signals
- Stars
- 1
- Forks
- 0
- Open issues
- 0
- Last commit (this folder)
- Mar 19, 2026 (7 months ago)
From GitHub (fetched Oct 24, 2026).
Details
- License
- License unknown
- Repository
- github.com/wwsun/skills
- First seen
- Oct 24, 2026
- Last checked
- Oct 24, 2026
- Source
- GitHubgithub-graphql
Same skill elsewhere
Copies of this SKILL.md published by others; search shows only one of them.
- 0.464score
crafting-effective-readmes
Microck
Use when writing or improving README files.
SkillDFreshness: D★ 5Claude Code +9 - 0.339score
crafting-effective-readmes
PhateValleyman
Use when writing or improving README files.
SkillAFreshness: AClaude Code +9 - 0.259score
crafting-effective-readmes
digitalspeed
Use when writing or improving README files.
SkillDFreshness: D★ 1Claude Code +9 - 0.257score
crafting-effective-readmes
pradeepmouli
Use when writing or improving README files.
SkillDFreshness: D★ 1Claude Code +9
More from wwsun
- 0.494score
daily-progress
wwsun
生成每日/每周工作进展报告。通过 /daily-progress 手动调用，从 git 提交记录中提取所有分支的变更，按类型（feat/fix/refactor 等）分组汇总，每条标注责任人，用 AI 智能总结为面向主管/团队的可读进展报告。支持位置参数：不传参数生成日报，传 week 生成周报。时间范围为前一天…
SkillCFreshness: C★ 1Claude Code +9 - 0.494score
java-web-scaffold
wwsun
初始化 java fullstack 工程（Java 21 + Spring Boot 3 + React 19 + MySQL + Redis）。只在用户明确输入 /java-web-scaffold 时才使用此技能，不要根据任务内容自动推断是否使用此 skill。
SkillCFreshness: C★ 1Claude Code +9 - 0.491score
gitlab-issues
wwsun
自动化整理 GitLab Issues。支持一键执行完整流程：自动为新增 Issue 打标 (tag) 和指派 (assign)，并生成包含新增、优先关注及分类统计的每日汇总报告。支持动态更新配置规则。
SkillCFreshness: C★ 1Claude Code +9 - 0.489score
move-skill
wwsun
将 .Codex/skills 中的技能迁移到 .agents/skills 目录，并在原位置创建软链接，实现跨工具共享。当用户说"把某个 skill 移动到 agents"、"迁移技能"、"共享 skill 到 .agents"、"把 skill 放到 agents 目录"、"sync skill to…
SkillCFreshness: C★ 1Claude Code +9 - 0.489score
repo-explorer
wwsun
深度探索和理解代码仓库的架构、核心模块、设计决策和工程化能力，帮助用户快速建立项目全局认知。 当用户说"帮我了解这个项目"、"这个项目是怎么工作的"、"我刚 clone 了这个仓库"、 "帮我分析这个代码库"、"这个项目的架构是什么"、"入口文件在哪"、"核心模块怎么组织的"、…
SkillCFreshness: C★ 1Claude Code +9 - 0.489score
agent-docs-creator
wwsun
为项目创建、更新和同步实现文档（implementation docs），帮助 Claude Code 等 coding agent 快速理解项目结构与实现细节。文档存储在项目 `agent_docs/` 目录，并在 AGENTS.md 中添加 `@agent_docs/index.md`…
SkillCFreshness: C★ 1Claude Code +9
Cite this page
crafting-effective-readmes skill. Agent Mart. https://agentmart.dev/skills/wwsun-crafting-effective-readmes (last updated 2026-10-24)