前言¶

在 DeepSeek Harness (DSH) 的插件生态中，为 GitHub 项目撰写 README 文档是常见的工作流任务。传统做法通常只负责输出文字，而配图往往需要手动处理。下面介绍 dsh-readme-writer，这是一个给 DSH 用的 Agent Skill，负责写 / 优化 GitHub 项目 README.md，并解决配图问题。

插件简介¶

这是一个由 wenbuer 维护的工作流类插件。它的核心作用是自动生成或改进 GitHub 项目的主页说明，同时处理配图细节。

核心功能¶

该插件基于 Cordis skill-bundle 架构，具备以下能力：

1. 自动类型判断与截图：根据目标项目类型（网页或 CLI）自动选择截图方式。网页项目生成网页截图，CLI 项目生成终端截图。
2. 图片路径管理：截图统一存放在项目的 images/ 文件夹，并使用相对路径引用，确保图片不会丢失。
3. 图文说明：每张图下方会自动配有说明文字，解释图片内容。
4. 无图兜底：如果无法截图，会自动切换到文字和表格模式，确保 README 内容完整。

安装与启用¶

安装命令如下：

dsh plugin --profile <profile> add wenbuer/dsh-readme-writer

安装完成后，该插件会作为 Cordis skill-bundle 加载，并在 host 层注册 readme-writer 技能。

使用方式¶

安装启用后，在 DSH 会话中直接输入以下指令：

“帮我写这个项目的 README”

技能会自动探测截图能力，并询问是否需要配图。随后，它将根据项目类型生成对应的 README 内容。

注意事项¶

1. 配图生成：插件自身不内置 README 示例截图，配图由技能在运行时为具体目标项目按需生成。
2. 图片存储：生成的图片统一存放在 images/ 目录下。
3. 许可证：该插件遵循 MIT 许可证。

生态链接¶

想了解更多或查看源码，可访问：
* dsh 插件目录
* GitHub 仓库