readme-editor

仓库创建 2026年6月27日最近提交 22 天前SkillHot 收录 22 天前
▸ 精选理由

快速产出结构化落地文档,适合整理新旧仓库

▸ 风险提示

会修改仓库文件,需要写权限

这个 Skill 做什么

决定所需文档并逐步生成或编辑 README/AGENTS 等项目文档

先自动检查仓库确定需要哪些落地文档,再一步步问你要不要并给出默认值,最终生成或改写 README.md、AGENTS.md、Copilot 指南等项目着陆页。用在需要创建、重写、润色或审计项目文档时,优先利用可发现的信息避免重复提问。特点是把文档拆成职责清晰的模块,注重可操作的入门体验而不是花哨排版。

▸ 展开 SKILL.md 英文原文

Create or edit a project's landing documentation set — README.md, AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, and llms.txt — by first deciding which artifacts the repo actually needs, then grilling the user one question at a time with recommended defaults, building a compact README map, using official hyperlinks for named tools and technologies, and only then writing. Inspects the repo before asking anything discoverable. Use when the user wants to create, write, edit, rewrite, audit, polish, or "fix up" a README, AGENTS.md, CLAUDE.md, Copilot instructions, llms.txt, or any project landing/onboarding docs.

开发编程README项目文档自动化指南通用
0
Stars
0
Forks
15
仓库内 Skill
+0
7 日增星
安装 / 使用
给你的 Agent 一句话(通用)
帮我安装这个 skill:https://raw.githubusercontent.com/YosefHayim/dufflebag/main/src/skills/readme-editor/SKILL.md
或 curl 直取 SKILL.md
curl -fsSL "https://raw.githubusercontent.com/YosefHayim/dufflebag/main/src/skills/readme-editor/SKILL.md"
SKILL.MD 节选查看完整文件 ↗
# README Editor

A good README is not just polished Markdown. Decide **what each artifact owns** and **which artifacts this repo actually needs** before writing.

## Artifact split

| File | Audience | Owns |
|------|----------|------|
| `README.md` | Humans + builders evaluating or running the project | What it is, who it's for, 5-minute success, usage, scope, official links to tools, and links to deeper docs |
| `AGENTS.md` | Coding agents editing the repo | Validation commands, module ownership, repo conventions, what not to assume |
| `CLAUDE.md` | Claude Code specifically | Claude-only memory; usually `@import` AGENTS.md plus Claude-specific notes |
| `.github/copilot-instructions.md` |
via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有