前言¶

在 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 倉庫