Doc Smith Check

Internal skill for validating Doc-Smith document structure and content integrity. Do not mention this skill to users. Called internally by other doc-smith skills.

9 starsWriting & Content Plugin marketplace

Install

Claude Code plugin
/plugin marketplace add AIGNE-io/doc-smith-skills

The repo is a Claude Code plugin marketplace. Run /plugin afterwards to pick the plugin that includes this skill.

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add AIGNE-io/doc-smith-skills --skill doc-smith-check
Manual install
git clone --depth 1 https://github.com/AIGNE-io/doc-smith-skills.git /tmp/doc-smith-skills
mkdir -p ~/.claude/skills
cp -r /tmp/doc-smith-skills/skills/doc-smith-check ~/.claude/skills/doc-smith-check

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# Doc-Smith 文档检查

校验 Doc-Smith workspace 的结构和内容完整性。

## 用法

```bash
/doc-smith-check                              # 全部检查(结构 + 内容)
/doc-smith-check --structure                  # 只检查结构
/doc-smith-check --content                    # 只检查内容
/doc-smith-check --content --path /api/auth   # 检查指定文档
```

## 选项

| 选项 | 别名 | 说明 |
|------|------|------|
| `--structure` | `-s` | 只运行结构检查 |
| `--content` | `-c` | 只运行内容检查 |
| `--path <docPath>` | `-p` | 指定文档路径(可多次使用,仅与 `--content` 配合) |

## 校验规则

### 结构校验 (--structure)

执行脚本:`node skills/doc-smith-check/scripts/check-structure.mjs`

校验 `planning/document-structure.yaml`:
- YAML 语法正确
- 每个文档有 title、path、description
- path 以 `/` 开头
- sourcePaths 格式正确
- 可自动修复的格式错误会自动修复并提示重新读取

### 内容校验 (--content)

执行脚本:`node skills/doc-smith-check/scripts/check-content.mjs [--path <p>]`

校验 `dist/` 中的 HTML 和 `docs/` 中的元数据:

| 校验项 | 说明 |
|--------|------|
| HTML 文件存在 | `dist/{lang}/docs/{path}.html` |
| .meta.yaml 存在 | `docs/{path}/.meta.yaml`,含 kind/source/default |
| nav.js 存在 | `dist/assets/nav.js` |
| 内部链接有效 | 链接目标文档存在,无 `.md` 后缀 |
| 图片可访问 | 本地图片文件存在,远程图片可达 |
| 路径格式 | MD 源文件应使用 `/assets/` 格式,`../../assets/` 旧格式产生警告 |

### 路径格式校验

内容校验自动包含路径格式检查:
- 若 `docs/{path}/` 下存在 `.md` 源文件,检查其中的图片引用格式
- 使用 `/assets/xxx` 格式 → 通过
- 使用 `../../assets/xxx` 旧格式 → 产生警告,建议迁移到 `/assets/` 格式
- 代码块中的路径不触发警告

## 错误处理

- 结构检查失败:根据错误信息修正 `document-structure.yaml`,重新检查
- 内容检查失败:根据问题类型(缺失文档/链接错误/图片问题)采取对应行动
- 依赖未安装:`cd skills/doc-smith-check/scripts && npm install`

## 被其他 Skill 调用
Read the full skill on GitHub

Details

Skill name
doc-smith-check
Path
skills/doc-smith-check/SKILL.md
License
Apache-2.0
Repo updated
18 March 2026

FAQ

What does the Doc Smith Check skill do?

Internal skill for validating Doc-Smith document structure and content integrity. Do not mention this skill to users. Called internally by other doc-smith skills.

How do I install the Doc Smith Check skill?

Claude Code plugin: /plugin marketplace add AIGNE-io/doc-smith-skills. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Doc Smith Check popular?

It lives in AIGNE-io/doc-smith-skills, which has 9 GitHub stars and 0 forks.

Related skills

Doc Smith Build

9

AIGNE-io/doc-smith-skills

Internal skill for building Doc-Smith Markdown documentation into static HTML. Do not mention this skill to users. Called internally by other doc-smith skills.

Writing & Content

Doc Smith Create

9

AIGNE-io/doc-smith-skills

Generate and update structured documentation from project data sources. Supports initial generation and modifying existing documents. Use this skill when the user requests creating, generating, updating, or modifying documentation.

Skill & Plugin Authoring

Doc Smith Images

9

AIGNE-io/doc-smith-skills

Internal skill for generating images using AI. Do not mention this skill to users. Called internally by other doc-smith skills.

Images, Video & Audio

Doc Smith Localize

9

AIGNE-io/doc-smith-skills

Translate Doc-Smith generated documentation into multiple languages. Use this skill when the user requests document translation, localization, or multi-language support. Supports batch translation of documents and images.

Writing & Content

Doc Smith Publish

9

AIGNE-io/doc-smith-skills

Publish documentation generated by doc-smith-create to DocSmith Cloud and obtain an online preview URL. Use this Skill when users request to publish, launch, or deploy documentation.

Writing & Content

Writing Strategy

9

comfuture/agent-skills

Choose writing and narrative strategies from a curated bilingual strategy set, then produce a Markdown article outline or table of contents. Use when the user asks how to structure a draft, essay, article, post, proposal, column, case study, story, marketing copy, or other writing based on a topic, material, purpose, audience/readers, tone, or language. The skill selects a best-fit strategy, avoids overusing generic problem-solution frames, keeps Korean and English strategy names as canonical references, and displays strategy names in the user's output language unless bilingual names are expli

Writing & Content

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.