Agent Skills
返回列表
📁

Textlint 可插拔自然语言检查器

办公效率 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/textlint-pluggable-natural-language-linter

技能介绍

为什么要给自然语言写 Lint

代码有 linter 守护,但项目中的文档、Markdown、注释和国际化文案往往游离在质量约束之外。结果是同一份产品文档里中英标点混用、同一术语出现多种拼写、遗留的 TODO 被发布到线上,团队评审时反复争论「该不该改」,而不是「改什么」。这些问题不会出现在 CI 的编译阶段,只会静默地影响专业度。

核心机制

这个技能把 ESLint 的插件思路移植到文本检查:textlint 提供规则加载与执行框架,具体检查逻辑由独立规则包承担。

工作流程大致如下:

  • 从 npm 安装 textlint 作为 dev 依赖
  • 按需安装社区规则,例如 textlint-rule-no-todo 用于拦截遗留待办标记
  • 运行 npx textlint --init 依据已装规则生成 .textlintrc.json 配置

配置采用类似 ESLint 的声明式结构,团队可以把「禁止中英标点混用」「统一特定术语拼写」「禁用口语化表达」固化为可执行规则,并在 CI 中对变更文档执行检查,让风格问题变成可阻断的工程问题而非口头约定。

适用边界

  • 不处理排版与结构:textlint 检查的是文本本身,无法替代 Markdown lint 或文档框架的模板能力。
  • 规则质量依赖社区:冷门语种或垂直领域的规则可能缺失,需要团队自行编写自定义规则。
  • 配置复杂度会随规则数量增长:当规则集较大时,需要在「严格」与「可维护」之间取舍,避免团队因误报泛滥而绕过检查。

使用场景

  • 开源项目维护文档仓库,需在 CI 中自动检查贡献者提交的文档是否符合标点与术语规范
  • 技术写作团队发布多语言文档,需在合并请求前拦截遗留 TODO 和不统一术语
  • 开发者编写 SDK 文档,需用规则校验 API 描述中中英文术语的一致性
  • 国际化团队处理多语言文案,需将特定表达规范固化为可执行的检查规则

适合人员

  • 技术文档工程师,负责维护多份产品文档,需要自动化检查文案风格一致性
  • 开源项目维护者,希望在 CI 中对贡献者提交的文档执行统一的 lint 规则
  • 国际化工程师,需要在多语言文案流水线中集成文本质量检查
  • 前端开发者,项目内含大量 Markdown 文档,希望像代码一样管理文档风格