词映 AI导航
工具库Skills 技能
我的收藏
词映 AI导航

ChatGPT readme-builder 技能：写简洁可扫读的 README

English

ChatGPT 安装步骤

  1. 在支持创建技能的 ChatGPT 工作区打开「插件 → 技能 → 创建 → 使用编辑器创建」。
  2. 对照固定版本 GitHub 原文，在编辑器新建技能，将 `readme-builder` 的纯文本工作流程改写为技能说明。
  3. 保存后，在新对话输入 @ 并选中刚创建的技能，再用示例试用。

中文摘要

用实际功能、依赖和用法写给技术读者的 README，保留最小示例和已知限制。

SKILL.md 中文导读

可复现示例

手动选择 readme-builder，把以下虚构项目说明整理成 README，首句说明用途。
project `Leaf Desk` | purpose=compare two plant labels on a desk
usage `Compare Labels` | sample `Fern and Aloe` | limitation `prototype only`
no coverage data or badges requested

工作步骤

  1. 写一句话说明项目要完成的任务。
  2. 添加必要的用法、依赖和最小示例。
  3. 清理空段落，核对功能范围和已知限制。

验收方法

给出 `Compare Labels` 的最小用法，并用 `Fern and Aloe` 做示例。明确标注 `prototype only`，省去徽章和未经证实的测试覆盖率。

GitHub 原文 · 更新日期

适用环境

支持创建技能的 ChatGPT 工作区。示例仅使用下方已给出的纯文本材料。

常见问题

需要补一个测试覆盖率数字让 README 更完整吗？

用可靠的项目说明和可复用的最小示例，让读者先了解功能与范围。

相关指南