writing-guidelines
Проверка документации по правилам Vercel
Что получите
Краткий список замечаний с привязкой к файлам и строкам в формате file:line.
Что передать
Файл или шаблон путей к документам для проверки.
Проверен состав файлов. Запуск не тестировался. Что проверено
Оценки пользователей
Как использовать
Помогает авторам и редакторам проверить документацию по Vercel Writing Guidelines. Охватывает стиль, тон, оформление и структуру текста.
- Укажите документы, которые нужно проверить.
- Используйте закреплённую версию правил; при необходимости попросите сравнить её с актуальной.
- Попросите проверить текст по всем правилам руководства.
Условия работы
- Основой проверки служит закреплённая копия руководства, поставляемая со скиллом; получение актуальной версии необязательно.
Пример запроса после установки
Проверь нашу инструкцию по установке по правилам Vercel: оцени тон, структуру и оформление, а замечания привяжи к конкретным строкам файла.
Пример составлен по инструкции автора; результат запуска не проверялся.
Основание: инструкция закреплённой версииДля установки
Node.js, npm и Git для команды выше. Подключения и инструменты для работы скилла настраиваются отдельно.
Совместимые агенты
Совместимость указана для инструкций. Запуск в каждом приложении не тестировался; для веб-чата способ подключения может отличаться.
Файлы скилла
GitHubЧитать инструкцию SKILL.md
Исходный текст закреплённой версии.
---
name: writing-guidelines
description: |
Review docs/prose for Writing Guidelines compliance. Use when asked to "review my docs", "check writing style", "audit prose", "review docs voice and tone", or "check this page against the writing handbook".
triggers:
- "review my docs"
- "check writing style"
- "audit prose"
- "review docs voice and tone"
- "writing handbook"
- "文档审查"
metadata:
author: vercel
version: "1.0.0"
argument-hint: <file-or-pattern>
od:
mode: prototype
surface: web
platform: desktop
category: documentation
upstream: "https://github.com/vercel-labs/writing-guidelines"
source-commit: 83e2316b034cf572400513538e4e4da01c4cc742
preview:
type: markdown
example_prompt: |
Review my documentation files for compliance with the Vercel Writing Guidelines — check voice, tone, formatting, and structure.
---
# Writing Guidelines
Review files for compliance with Writing Guidelines.
## How It Works
1. Load the pinned guidelines from [`references/guidelines.md`](references/guidelines.md) — this is the default, reproducible execution path
2. Optionally, fetch the latest guidelines from the upstream URL below and diff against the pinned snapshot to see if anything has changed
3. Read the specified files (or prompt user for files/pattern)
4. Check against all rules in the guidelines
5. Output findings in the terse `file:line` format
## Guidelines Source
**Default (pinned):** The vendored copy at [`references/guidelines.md`](references/guidelines.md) is the default execution path. It is a pinned snapshot of the upstream guidelines and guarantees the skill produces reproducible results in any runtime environment.
**Upstream (live):** For users who want the very latest rules, the live source is available at:
```
https://raw.githubusercontent.com/vercel-labs/writing-guidelines/main/command.md
```
Fetching the live version is optional — the pinned snapshot is always the baseline.
## Usage
When a user provides a file or pattern argument:
1. Load [`references/guidelines.md`](references/guidelines.md) as the default source
2. Optionally fetch the upstream URL to check for updates
3. Read the specified files
4. Apply all rules from the guidelines
5. Output findings using the format specified in the guidelines
If no files specified, ask the user which files to review.
Проверка и особенности
Автоматическая проверка источника и файлов
Автоматически сверены публичный репозиторий, лицензия, YAML-заголовок SKILL.md, состав папки и Git-хеш каждого файла. Исполняемые файлы и срабатывания статических правил исключены из этой партии. Ручной аудит всех инструкций и проверка работы не проводились; эта проверка не гарантирует безопасность. Команда закреплена на проверенном коммите.
Интерес к репозиторию оцениваем по звёздам и форкам GitHub. Это показатели всего репозитория, а не числа установок отдельного скилла.
Есть ссылки на внешние инструкции или инструменты: их содержимое и доступность могут изменяться отдельно от скилла.
- Проверка состава
- 16.09.2026
- Проверенная версия
eca7c7ab9898- Файлы с кодом
- Не указаны в данных проверки
- Изменения на GitHub
- Нужна повторная проверкаПоследняя проверка: 11.10.2026
Репозиторий и лицензия
Это показатели всего репозитория, а не установки скилла. Снимок требует обновления.
- Последняя активность GitHub
- 11.10.2026
- Лицензия
- MIT
- Добавлен в каталог
- 16.09.2026
Полный текст лицензии
MIT License Copyright (c) 2026 Vercel Labs Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Ещё в этой категории
Все в категорииОбсуждение
ПравилаПользовались этим скиллом? Делитесь опытом без регистрации. Все комментарии проверяет модератор.
