Readme Style

创建或修改 README.md 前必须读取并遵守本 skill。按 4 章骨架生成或精简仓库根级 README.md,只装新读者 3 分钟能上手的内容;只处理仓库根的单文件。即使没人让你动 README,只要本次工作改了安装方式、命令用法或用户可见能力,也必须主动触发本 skill 检视是否需要同步更新。

caikiji 3c3fa9c 2.0 KB Updated

File contents

README.md Skill

生成或精简仓库根级 README.md;只装新读者 3 分钟能用上的内容,过不了就砍,或移到 docs/。

骨架(4 章)

# <项目名>

> 写一句话定位:做什么 + 解决什么问题,不写营销话。

## 特性
- 写 ≤5 条区分性能力(与同类项目的差异),不写全能彩列

## 快速开始
- 写安装 + 最小可用示例(可复制,含预期输出)

## 文档
- 列索引链接(深度用法、API、贡献指南),不内联

## License
- 写许可名;无则省略

装 / 不装

✅ 装 ❌ 不装
一句话定位 版本号、发布历史、changelog
≤5 条区分性特性 穷尽式功能列表
安装 + 最小示例 详细配置、全部 API(链接 docs)
文档/贡献索引 维护状态声明、贡献者名单
License 大量截图、CI badge

生成

  1. 扫描 manifest(项目名、license、CLI 入口命令)、现有 README.md(素材)、docs/ 目录(索引来源)。
  2. 按骨架写出,每条过一遍筛选标准;示例命令与预期输出必须真实可验证,禁止编造。
  3. 语言跟随项目现状。

诊断(瘦身)

读现有 README.md,逐项处理:

  1. 删快速过期内容:badge、版本号、发布历史。
  2. 删膨胀:穷尽功能列表 → 特性摘要;截图堆 → 留代表图。
  3. 把细节移到 docs/:配置说明、API 参考、部署步骤。

输出:删除/修改清单(每项一句理由)+ 瘦身后的全文。

验证

跑一遍快速开始中的最简命令,确认真实可用。

caikiji/skills-lab/tree/main/skills/deprecated/readme-style commit 3c3fa9c996

Frequently asked questions

npx skillmds@latest add caikiji/readme-style