---
id: gh-writing-guidelines
name: "writing-guidelines"
url: https://skills.yangsir.net/skill/gh-writing-guidelines
author: vercel-labs
domain: writing
tags: ["writing-guidelines", "documentation", "content-quality", "technical-writing", "prose-review"]
install_count: 103300
rating: 4.80 (120 reviews)
github: https://github.com/vercel-labs/agent-skills/tree/main/skills/writing-guidelines
---

# writing-guidelines

> 此技能能够自动审查文档和文本内容，确保其符合预设的写作规范和风格指南。它通过自动化检查，显著提升了文档质量和一致性，减少了人工审查的时间和错误率。无论是技术文档、API 说明、用户手册，还是博客文章和营销材料，该 Skill 都能帮助团队维护专业的品牌形象和清晰的沟通标准，确保所有对外发布的内容都达到高水准，从而提高沟通效率和用户体验。

**Stats**: 103,300 installs · 4.8/5 (120 reviews)

## Before / After 对比

### 文档审查效率与质量

**Before**:

在没有这个技能之前，用户需要手动审查大量文档，耗时费力且容易遗漏错误，导致文档质量参差不齐，风格不一致，影响专业形象和沟通效率。

**After**:

此技能自动检查文档，显著减少了审查时间，提高了准确性，确保所有内容符合统一的写作规范，从而提升文档整体质量和团队的专业度。

| Metric | Before | After | Change |
|---|---|---|---|
| 审查时长 | 120分钟 | 10分钟 | -91% |
| 错误遗漏率 | 30% | 5% | -83% |

## Readme

# Writing Guidelines

Review files for compliance with Writing Guidelines.

## How It Works

1. Fetch the latest guidelines from the source URL below
2. Read the specified files (or prompt user for files/pattern)
3. Check against all rules in the fetched guidelines
4. Output findings in the terse `file:line` format

## Guidelines Source

Fetch fresh guidelines before each review:

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

Use WebFetch to retrieve the latest rules. The fetched content contains all the rules and output format instructions.

## Usage

When a user provides a file or pattern argument:
1. Fetch guidelines from the source URL above
2. Read the specified files
3. Apply all rules from the fetched guidelines
4. Output findings using the format specified in the guidelines

If no files specified, ask the user which files to review.


---
*Source: https://skills.yangsir.net/skill/gh-writing-guidelines*
*Markdown mirror: https://skills.yangsir.net/api/skill/gh-writing-guidelines/markdown*