Ype! Writer:用 rule.toml 做可复现的段落级文章审校

前言

在 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。

注意:

  1. 插件以当前 DSH 进程权限运行,安装前应阅读源码与 MIT 许可证,确认规则与过滤器中的 Python 代码可信。
  2. LLM 规则会产生 token 消耗;脚本规则与过滤器本地执行,不占模型额度。
  3. 社区插件目录 SkillHub 为独立站点,与 DeepSeek / 幻方无官方从属关系;星标与分类以目录页为准(当前资料:模型推理,GitHub 1 stars)。

结尾

Ype! Writer 把「怎么算合格段落」从口头约定落到 rule.toml,用一会话一规则的方式降低评分漂移,并配合模板、过滤器与 Web 报告缩短改稿循环。

  • 目录页:https://www.skillhub.cn/plugins/catilgrass/ype-writer
  • 仓库:https://github.com/catilgrass/ype-writer
羽毛球分组比赛记分
小程序二维码

欢迎使用《羽毛球分组比赛记分》微信小程序

小夜