前言¶
在 DSH 裏寫長文或技術稿時,「寫得像不像目標讀者」「有沒有踩寫作禁忌」往往依賴單次對話裏的主觀判斷,換模型、換會話後標準很難對齊,也不方便把審校規則放進倉庫隨稿迭代。Ype! Writer(dsh-ype-writer)把審校標準寫進 rule.toml,按段落調用大模型打分;每條規則單獨開會話,便於復現、review 和提交版本。下面介紹插件定位、能力與典型用法。
這是什麼¶
Ype! Writer 是維護者 catilgrass 發佈的 DSH 插件,在 SkillHub 上歸類爲模型推理。一句話:對照 rule.toml 對文章逐段打分,每條規則獨立 LLM 會話,使評分標準可復現、可審閱、可納入版本控制。
包名 dsh-ype-writer,當前資料中的版本爲 0.1.0,許可證 MIT。無額外運行時依賴(TOML 解析隨包提供);僅在使用 script 或 filter 規則時需要 Python 3。
核心功能¶
規則驅動的段落審校¶
主工具爲 ype_check:指定規則文件或內置模板,以及正文或文件路徑,返回 Markdown 報告(value.report)及結構化逐段、逐規則結果;報告保留各規則原始分,便於重算總分。
一類規則一會話¶
反模式(anti-patterns)、禁忌(don’ts)、硬性要求(requirements)等分別在獨立會話中執行。配置 llm = N 時可跑多副本並取平均。另有 Python 腳本類規則,做確定性檢查且不消耗 token。
受衆與反受衆¶
兩個獨立會話分別評估「是否符合目標受衆」與「反受衆是否仍能讀懂」,並據此計算「迎合指數」(pandering index),與 rule.toml 中的目標對比。
過濾器¶
通過 [[filters]] 用 Python 定義 filter(text),只審校選定片段;返回字符串按段落切分後供各會話共用。倉庫自帶 filters/comments.py、filters/markdown.py、filters/code.py,也可在規則內聯 code。過濾器按聲明順序執行;若篩選結果爲空則檢查失敗而非對空文打分,報告中會列出已用過濾器及剔除字符數。
臨時規則¶
當 rule 指向非法 TOML(如 Markdown 審閱說明、殘缺規則)時,工具可嘗試生成或修復爲合法規則再執行審校,草稿不寫盤;可通過插件配置 autoDraftRules: false 關閉。此路徑最多額外消耗一到兩次模型調用,適合一次性 review。
技能與模板¶
加載後在有 skill 服務的 profile 註冊 ype-writer 技能,推薦流程爲:成稿 → 複製模板到 rule.toml → 調整 → ype_check → 按報告修改。templates/ 提供八類英文模板(如 tutorial-guide、health-science、code-review 等),中文副本在 templates/zh_CN/,文件名一一對應。
Web 端展示¶
瀏覽器側在每次 ype_check 後展示卡片(分數、段落數、警告數),「Open report」打開 Article Review Report 面板(環形分、逐段條、規則表、警告)。若安裝插件時 DSH 已在運行,需重啓一次 DSH 進程以加載客戶端模塊註冊表。
安裝與啓用¶
環境要求:帶插件管理器的 DSH(plugin_manager 或 Creator 模式)、Node.js 20 及以上;僅 script/filter 規則需要 Python 3。
在要啓動的 profile 下(將 web 換成你的 profile 名):
dsh plugin --profile web add github:catilgrass/ype-writer
包會自動加入 dsh.profile.bundles;支持 HMR,否則重啓 dsh web。卸載:
dsh plugin --profile web remove dsh-ype-writer
Web UI:側欄 Plugins → Add plugin → 填入 https://github.com/catilgrass/ype-writer → Install。
本地 checkout 開發時,可用 plugin_manager 的 target 指向絕對路徑,改代碼後需重新安裝。安裝後應能在工具列表看到 ype_check,skill 目錄中有 ype-writer。
典型用法¶
對文件與規則路徑:
ype_check(rule: "examples/rule.toml", path: "examples/article.md")
參數(rule/template 二選一,text/path 二選一):
| 參數 | 含義 |
|---|---|
rule |
規則文件路徑,相對或絕對會話工作目錄 |
template |
內置模板名,如 health-science、zh_CN/health-science、tutorial-guide |
text |
全文正文 |
path |
文章文件路徑 |
冒煙示例(資料原文):
ype_check(template: "tutorial-guide", text: "This is a smoke test.")
審閱本倉庫 README 的示例:
ype_check(rule: "readme-review.toml", path: "README.md")
完整 rule.toml 字段說明見 GitHub 倉庫 examples/rule.toml。
適用場景與注意¶
適合:需要在 DSH 工作流中固定寫作標準的技術作者、教程與文檔維護者、希望把審校規則與稿件同庫管理的團隊。內置模板覆蓋科普、教程、新聞、觀點、產品評測、代碼評審等類型,可按受衆與禁忌自行擴寫 rule.toml。
注意:
- 插件以當前 DSH 進程權限運行,安裝前應閱讀源碼與 MIT 許可證,確認規則與過濾器中的 Python 代碼可信。
- LLM 規則會產生 token 消耗;腳本規則與過濾器本地執行,不佔模型額度。
- 社區插件目錄 SkillHub 爲獨立站點,與 DeepSeek / 幻方無官方從屬關係;星標與分類以目錄頁爲準(當前資料:模型推理,GitHub 1 stars)。
結尾¶
Ype! Writer 把「怎麼算合格段落」從口頭約定落到 rule.toml,用一會話一規則的方式降低評分漂移,並配合模板、過濾器與 Web 報告縮短改稿循環。
- 目錄頁:https://www.skillhub.cn/plugins/catilgrass/ype-writer
- 倉庫:https://github.com/catilgrass/ype-writer