mcpField
W
writing-guidelines

writing-guidelines

github.com/nexu-io文档处理104.6k930 次安装1 天前更新
代码仓库

关于 writing-guidelines

writing-guidelines 是一项按固定写作规则检查文件的技能。它以简洁的文件和行号格式报告问题,也可选择与上游规则比较。

主要功能

  1. 01固定且可复现的规则快照
  2. 02可选的上游规则比较
  3. 03检查指定文件或匹配模式
  4. 04以文件和行号简报问题

适用场景

  1. 01按统一写作标准检查文档
  2. 02审查指定文件或匹配模式

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/nexu-io/open-design --skill writing-guidelines

安装后在 Claude Code 中输入/writing-guidelines确认已加载。

附带文件LICENSEreferences/guidelines.md

详细介绍

写作指南

检查文件是否符合写作指南。

工作原理

  1. 加载固定版本的指南 references/guidelines.md——这是默认且可复现的执行路径
  2. 可选:从下方的上游 URL 获取最新指南,并与固定版本快照进行比较,查看是否有变化
  3. 阅读指定文件(或提示用户提供文件/模式)
  4. 根据指南中的所有规则进行检查
  5. 按简洁的 file:line 格式输出问题

指南来源

默认(固定版本): references/guidelines.md 中随附的副本是默认执行路径。它是上游指南的固定版本快照,可确保此技能在任何运行时环境中都能产生可复现的结果。

上游(实时): 对于希望获取最新规则的用户,可通过以下地址访问实时来源:

https://raw.githubusercontent.com/vercel-labs/writing-guidelines/main/command.md

获取实时版本是可选的——固定版本快照始终是基准。

用法

用户提供文件或模式参数时:

  1. 将 references/guidelines.md 作为默认来源加载
  2. 可选:获取上游 URL,以检查更新
  3. 阅读指定文件
  4. 应用指南中的所有规则
  5. 使用指南中指定的格式输出问题

如果未指定文件,请询问用户要检查哪些文件。

评论

支持 Markdown