Document Style Guide

document-style-guide-skill

这是一个用于存放 Claude Code marketplace plugin 的仓库，用来提供基于中文文档规范的可复用 plugin 与 skill。

为什么创建这个Skill (这是人工写的)

项目总是需要写手册和文档,document-style-guide 非常好,但是开始使用时总是记不住(你会发现这段话其实就有不符合规范的地方...),所以写一个skill帮助我对写好的文件进行review,这样写的时候可以随便写(可能后续写熟了就能符合规范了吧....),然后claude code review改一下完事~~~ 哈哈 ~~~

仓库内容

当前仓库包含：

• 一个 marketplace 定义
• 一个 plugin：document-style-guide
• 一个 skill：zh-review

zh-review 可以直接处理：

• Markdown 文件
• 受支持代码文件中的注释

当输入是目录时，它会递归处理：

• 所有 Markdown 文件
• 所有受支持的代码文件，但只修改其中的注释

仓库结构

.
├─ .claude-plugin/
│  └─ marketplace.json
├─ plugins/
│  └─ document-style-guide/
│     ├─ .claude-plugin/
│     │  └─ plugin.json
│     └─ skills/
│        └─ zh-review/
│           ├─ SKILL.md
│           └─ reference/
│              ├─ marks.md
│              ├─ number.md
│              ├─ paragraph.md
│              ├─ reference.md
│              ├─ structure.md
│              ├─ text.md
│              └─ title.md
├─ RELEASE_CHECKLIST.md
└─ README.md

使用方式

使用 skill 时，传入一个文件或目录即可：

/document-style-guide:zh-review docs/

/document-style-guide:zh-review docs/intro.md

/document-style-guide:zh-review src/example.py

行为说明

• Markdown 文件会按照 reference/ 中的规范直接修改。
• 代码文件也支持处理，但只允许修改注释。
• skill 不允许修改可执行代码、标识符、字符串字面量、配置值或程序行为。
• SKILL.md 只保存执行行为与边界。
• 具体写作规范保存在 plugins/document-style-guide/skills/zh-review/reference/ 中。

规范来源

本仓库中的 reference/ 规范整理自：

• ruanyf/document-style-guide

本仓库的作用是将这些规范封装为可在 Claude Code 中使用的 plugin skill。

说明

• 这是一个 marketplace/plugin 仓库，不是原始规范仓库。
• 如果后续更新 reference/ 内容，应继续保留来源说明。

---

A Claude Code marketplace repository for revising Chinese documentation with a reusable plugin and skill.

What this repository provides

This repository currently contains:

• one marketplace definition
• one plugin: document-style-guide
• one skill: zh-review

zh-review directly revises:

• Markdown files
• comments inside supported code files

When given a directory, it recursively processes:

• all Markdown files
• all supported code files, but only their comments

Repository structure

.
├─ .claude-plugin/
│  └─ marketplace.json
├─ plugins/
│  └─ document-style-guide/
│     ├─ .claude-plugin/
│     │  └─ plugin.json
│     └─ skills/
│        └─ zh-review/
│           ├─ SKILL.md
│           └─ reference/
│              ├─ marks.md
│              ├─ number.md
│              ├─ paragraph.md
│              ├─ reference.md
│              ├─ structure.md
│              ├─ text.md
│              └─ title.md
├─ RELEASE_CHECKLIST.md
└─ README.md

Usage

Invoke the skill with a file or a directory:

/document-style-guide:zh-review docs/

/document-style-guide:zh-review docs/intro.md

/document-style-guide:zh-review src/example.py

Behavior

• Markdown files are revised directly according to the reference rules.
• Code files are supported, but only comments may be edited.
• The skill must not modify executable code, identifiers, string literals, configuration values, or program behavior.
• SKILL.md contains execution behavior and boundaries.
• The concrete writing rules live in plugins/document-style-guide/skills/zh-review/reference/.

Rule source

The writing rules in reference/ are derived from:

• ruanyf/document-style-guide

This repository repackages those rules for use inside a Claude Code plugin skill.

Notes

• This repository is intended as a marketplace/plugin repository, not as the original source of the writing rules.
• If you update the reference files, keep the rule source attribution intact.