README 撰写助手 wenbuer/dsh-readme-writer

dsh-readme-writer

这个技能帮你写或改进 GitHub 项目的主页说明（README），还会顺手给项目配上图。能截网页就截网页；只有命令行程序、没有网页的，就把程序跑起来的样子画成一张终端图；实在截不了，就用文字和表格把界面讲清楚，说明照样完整。

type
category
License
verify

这是什么

这是给 DeepSeek Harness（dsh）用的一个技能。你只要说「帮我写这个项目的 README」，它就会帮你把 GitHub 项目的主页说明写好或改好。

它和一般「只负责出文字」的 README 工具最大的不同是：它会尽量给项目配上图，而且图不是乱放的，会看情况来：

- 项目有网页 → 截一张网页的图放进去；
- 项目是命令行程序、没有网页 → 把程序跑起来的样子画成一张终端图；
- 两种都做不到 → 就用文字和表格把界面讲清楚，README 照样完整，不会放个空图占位。

这个技能能在 dsh 的插件市场里被搜到，因为它的说明文件里已经写好了标题、简介、关键词、分类和版本号。

它好在哪里

- 不用你操心图怎么弄：它先看当前环境能不能截图，能就走截图的路线，截不到就自动退回「只用文字」。
- 图不会丢：截图统一放在项目里的 images/ 文件夹，用相对路径引用。换电脑、传到 GitHub，图都找得到。
- 每张图都有说明：图下面会配一句话，告诉读者这张图在讲什么。
- 同类工具大多不配图：像 docgen 这类主要只生成文字，这个技能把「配图」这一条补上了。

安装

方式一：dsh plugin add（推荐，装完即用）

~~~bash
dsh plugin add
dsh plugin --profile add wenbuer/dsh-readme-writer

或从 git / 本地目录
dsh plugin --profile add github:wenbuer/dsh-readme-writer
dsh plugin --profile add file:../dsh-readme-writer

本包是 cordis skill-bundle：package.json 里 dsh.bundle.patch 指向 cordis.patch.yml。
dsh plugin add 会把它加进 profile 的 dsh.profile.bundles，并在 host 层用
lib/index.js 的 apply(ctx) 向 ctx.skills 注册 readme-writer 技能。
装完重启 dsh，即可在可用技能里看到 readme-writer。

方式二：放进用户级技能目录（手动，立即生效）

~~~bash
mkdir -p ~/.dsh/skills/readme-writer
cp skills/readme-writer/SKILL.md ~/.dsh/skills/readme-writer/

使用

直接说「帮我写这个项目的 README」即可。技能会：自动探测截图能力 →（支持）询问是否要图 → 按「有截图」或「无截图」模板生成，并遵循相对路径 + 配图说明约定。

截图 / Screenshots

插件自身的展示截图（供 dsh-market 详情页 / 本 README 使用；由 screenshots.json 声明）：

verify
图 1：npm run verify —— 真实校验输出，证明 readme-writer 能经插件 provider 正确发现并加载。

terminal
图 2：终端截屏 —— 对「无网页的控制台 / CLI」项目，技能把运行输出渲染成终端样式截图。

这两张是插件自身的展示截图；技能为每个目标项目写 README 时按需生成的配图仍遵循「图存 images/、相对路径、每张一句说明」的约定（见 SKILL.md 3.0~3.4），二者不是一回事。

目录结构

dsh-readme-writer/
├── package.json # name/version + main/exports + dsh.bundle.patch
├── README.md
├── LICENSE
├── CHANGELOG.md
├── screenshots.json # 声明 1-8 张展示截图（dsh-market 详情页用） ├── cordis.patch.yml # 把本插件挂进 profile bundle 的 patch 层 ├── assets/ # 插件自身展示截图（readme-writer-*.png） ├── lib/ │ └── index.js # cordis 插件：apply(ctx) 向 ctx.skills 注册 readme-writer 技能 ├── scripts/ │ └── verify-provider.mjs # 独立校验：skill 能通过 provider 加载（npm run verify） ├── .github/ │ └── workflows/ │ └── verify.yml # CI：每次 push 跑 npm run verify ├── submission/ │ └── wenbuer__dsh-readme-writer.yml # awesome-dsh-plugin 投稿条目（data/plugins 用） └── skills/ └── readme-writer/ └── SKILL.md # 含可搜索元数据（name/description/keywords/category/version）

技能不随包内置 README 示例截图——配图由技能在写 README 时为具体目标项目按需截图生成（见 SKILL.md 3.0~3.4）。
上文 assets/ 里是插件自身的展示截图（只用于本 README / dsh-market 详情页，经 screenshots.json 声明），与「技能为每个项目现场生成的那类配图」是两回事，请勿混用。

发布与投稿

想通过 dsh plugin add 安装、并进入 dsh 插件商城（SkillHub）搜索到本技能：

1. 把本仓库推到 GitHub（公开）——已完成。
2. 进英文列表以 GitHub 仓库地址 提交即可：dsh plugin add github:wenbuer/dsh-readme-writer 能装，不需要 npm 包（发布与否不影响收录）。投稿条目见 submission/wenbuer__dsh-readme-writer.yml， category: skill，description.en 必填、已含句号。
- 前提（CI 自动检查，需你先满足）：仓库满 1 天、提交数 ≥ 10、给仓库加 dsh-plugin topic。
3. 若日后发布到 npm，dsh plugin add dsh-readme-writer 才能从 registry 装到；商城也会按下载量展示。

投稿时突出差异化：README 配图 + 截图自适应（探测 → 有图/无图/终端截屏 → 相对路径 + caption），与 docgen 等「文本生成」区分开。

仓库内 npm run verify 会独立校验：模拟 host 的 ctx.skills，调用插件的 provider list()/get()，确认 readme-writer 能被正确发现并加载 —— 供评审对照源码核验。

许可证

MIT