Agent skill

Docs Creator

by shenjingnan in shenjingnan/xiaozhi-client

“文档创建技能,用于创建标准化的项目文档”

— description from SKILL.md by shenjingnan
MITAuto-check passedAgent Workflows

Install Docs Creator

skills CLI
$ npx skills add shenjingnan/xiaozhi-client --skill docs-creator -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install shenjingnan/xiaozhi-client docs-creator --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/shenjingnan/xiaozhi-client.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-creator .claude/skills/docs-creator && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs-creator
GitHub stars
341
Token cost
~614 tokens
SKILL.md length
135 words
Files
1
Skills in repo
16
Repo updated
First seen
Licence
MIT

At a glance

  • Works in 4 steps: 确定文档参数 - 根据类型确定正确的文件路径和命名 → 生成文档内容 - 创建符合项目标准的文档 → 更新导航配置 - 自动更新文档导航 → …
  • SKILL.md covers 我的能力, 使用方式, 支持的文档类型 and 文档风格要求, plus 3 more sections
  • Calls pnpm, curl and npm

About this skill

Docs Creator is a skill in shenjingnan/xiaozhi-client (341 stars). Its SKILL.md is about 614 tokens. Licence: MIT.

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. 确定文档参数 - 根据类型确定正确的文件路径和命名
  2. 生成文档内容 - 创建符合项目标准的文档
  3. 更新导航配置 - 自动更新文档导航
  4. 执行质量检查 - 验证文档语法、链接和路径别名

What it can do on your machine

Read from SKILL.md and the folder at commit fe3c382. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • pnpm
    • curl
    • npm

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use pnpm, curl and npm, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs Creator loads about 614 tokens when it runs. Until then it costs about 8 tokens; SKILL.md has 135 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~8
When it runs · the whole SKILL.md, loaded when a task matches
~614

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from shenjingnan/xiaozhi-client at commit fe3c382, republished under its MIT licence (© shenjingnan). 135 words, ~614 tokens.

Download SKILL.mdSave it as .claude/skills/docs-creator/SKILL.md (or your agent's skills folder).
name
docs-creator
description
文档创建技能,用于创建标准化的项目文档

文档创建技能

我是一个文档创建专家,专门为 xiaozhi-client 项目创建符合标准的高质量文档。

我的能力

当你需要创建新文档时,我会:

  1. 确定文档参数 - 根据类型确定正确的文件路径和命名
  2. 生成文档内容 - 创建符合项目标准的文档
  3. 更新导航配置 - 自动更新文档导航
  4. 执行质量检查 - 验证文档语法、链接和路径别名

使用方式

使用格式:/docs-create [文档类型] [文档标题]

示例:

  • /docs-create mcp-tool "Docker容器部署指南"
  • /docs-create dev-guide "MCP Server开发详解"
  • /docs-create api-doc "CLI命令完整参考"
  • /docs-create user-manual "多端点配置入门"
  • /docs-create arch-doc "独立多接入点架构设计"

支持的文档类型

mcp-tool - MCP 工具文档
  • 路径:docs/content/guides/mcp-tools/{filename}.mdx
  • 用途:为特定 MCP 工具或功能创建使用文档
  • 模板内容:
    • 功能介绍和适用场景
    • 配置方法和参数说明
    • 使用示例(基础和高级)
    • 常见问题和故障排除
dev-guide - 开发指南
  • 路径:docs/content/development/{filename}.mdx
  • 用途:开发相关的指南文档
  • 模板内容:
    • 开发背景和目标
    • 技术架构说明
    • 实施步骤和代码示例
    • 测试方法和验证流程
api-doc - API 参考文档
  • 路径:docs/content/api/reference/{filename}.mdx
  • 用途:API 接口或命令参考文档
  • 模板内容:
    • 接口或命令概述
    • 参数详解和格式说明
    • 返回值和错误码
    • 完整示例代码
user-manual - 用户手册
  • 路径:docs/content/getting-started/{filename}.mdx
  • 用途:用户入门和操作指南
  • 模板内容:
    • 使用场景和目标用户
    • 操作步骤和界面说明
    • 配置选项和自定义设置
    • 常见问题解答
arch-doc - 架构文档
  • 路径:docs/content/architecture/{filename}.mdx
  • 用途:系统架构和设计文档
  • 模板内容:
    • 架构概述和设计原理
    • 组件关系和数据流
    • 技术选型和权衡考虑
    • 扩展性和性能考虑

文档风格要求

  • 简洁直白:围绕 MCP 客户端功能,避免冗余表述
  • 减少 emoji 使用:保持技术文档专业性
  • 结构清晰:使用合适的标题层级和表格
  • 代码示例:提供完整、可运行的命令和代码示例
  • 中文优先:使用中文编写说明性内容,变量名保持英文

质量检查与验证

基础质量检查
bash
# 拼写检查
pnpm spellcheck

# 代码格式检查
pnpm lint
路径别名验证(重要!)

确保文档中的代码示例遵循 xiaozhi-client 项目规范:

  1. 检查代码示例中的 import 语句
  2. 检查相对路径使用情况
  3. 检查 MCP 相关的导入路径(@core/, @transports/, @cli/* 等)
本地验证(重要!)

为了避免部署报错,必须在本地验证文档:

bash
# 启动文档服务
pnpm dev:docs

# 等待服务启动后检查状态
curl -s -o /dev/null -w "%{http_code}" http://localhost:3000

验证成功标准:

  • 文档服务启动无报错
  • 首页返回 200 状态码
  • 新创建的文档页面可以正常访问
  • 无拼写和语法错误
  • 代码示例格式正确
  • 代码示例使用正确的 xiaozhi-client 路径别名
  • 导航菜单正确显示新文档

代码示例规范

typescript
// ✅ 推荐的导入示例
import { UnifiedMCPServer } from "@core/unified-server";
import { IndependentXiaozhiConnectionManager } from "@managers";
import { XiaozhiConfig } from "@/types";

// ❌ 避免相对路径
import { UnifiedMCPServer } from "../../core/unified-server";

命令行示例规范

bash
# ✅ 使用项目实际命令
pnpm build
pnpm dev
pnpm dev:docs
xiaozhi start --config ./xiaozhi.config.json

# ❌ 避免使用不存在的命令
nr dev
npm run build

© shenjingnan, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/docs-creator of shenjingnan/xiaozhi-client.

Open the folder on GitHubat commit fe3c382

Compare with similar skills

Docs Creator next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs Creator compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Creator this skillshenjingnan/xiaozhi-client341—~614Automated safety check: PassMIT
MCP Server Builderanthropics/skills180k63 repos~2.3kAutomated safety check: PassApache-2.0
MCP Server BuildershareAI-lab/learn-claude-code78k5 repos~1.2kAutomated safety check: PassMIT
MCP Integration for Pluginsanthropics/claude-plugins-official38k11 repos~3.1kAutomated safety check: PassApache-2.0
Crush Configurationcharmbracelet/crush29k—~3.7kAutomated safety check: PassCustom licence
Context Mode Output Sandboxmksglu/context-mode26k—~4.1kAutomated safety check: PassCustom licence

Similar skills

  • MCP Server Builder

    anthropics/skills

    Official

    Guides the design and implementation of Model Context Protocol servers in TypeScript or Python, from tool naming and error messages to evaluation.

    180k GitHub starsUsed in 63 repos~2.3k tokens
    Agent WorkflowsAuto-check passed
  • MCP Server Builder

    shareAI-lab/learn-claude-code

    Walks through building MCP servers in Python or TypeScript that expose tools, resources and prompts to Claude, with templates, registration and testing.

    78k GitHub starsUsed in 5 repos~1.2k tokens
    Agent WorkflowsAuto-check passed
  • MCP Integration for Plugins

    anthropics/claude-plugins-official

    Official

    Explains how to bundle Model Context Protocol servers in a Claude Code plugin, covering config files, stdio, SSE, HTTP and WebSocket server types, and authentication.

    38k GitHub starsUsed in 11 repos~3.1k tokens
    Agent WorkflowsAuto-check passed
  • Crush Configuration

    charmbracelet/crush

    Explains how to configure the Crush coding agent with crushrc or crush.json, covering providers, models, LSPs, MCP servers, hooks, permissions and config precedence.

    29k GitHub stars~3.7k tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Context Mode Output Sandbox

    mksglu/context-mode

    Routes large command, file, API and browser output through context-mode tools so only the needed result enters the agent's context, instead of dumping it via Bash.

    26k GitHub stars~4.1k tokensUpdated yesterday
    Agent WorkflowsAuto-check passed
  • Migrates the compatible subset of settings and global file-based MCP servers from the Warp desktop app into Warp Agent CLI without exposing credentials or state.

    65k GitHub starsUsed in 1 repo~2.1k tokens
    Agent WorkflowsAuto-check passed

More from shenjingnan/xiaozhi-client

All 16 skills in this repo
  • E2E Coverage Analyzer

    shenjingnan/xiaozhi-client

    分析当前分支 git 改动,检查 e2e 测试用例覆盖情况,并可补充缺失的测试用例. An agent skill from shenjingnan/xiaozhi-client.

    341 GitHub stars~954 tokensUpdated 1 mo ago
    Auto-check passed
  • Fix Comment

    shenjingnan/xiaozhi-client

    GitHub 评论修复技能,用于获取 PR 的 Copilot 评论并分析修复问题. An agent skill from shenjingnan/xiaozhi-client.

    341 GitHub stars~873 tokensUpdated 1 mo ago
    Auto-check passed
  • API Docs

    shenjingnan/xiaozhi-client

    文档自动生成

    341 GitHub stars~2.4k tokensUpdated 1 mo ago
    Auto-check passed
  • CI Validator

    shenjingnan/xiaozhi-client

    CI检查验证和质量保障

    341 GitHub stars~2.1k tokensUpdated 1 mo ago
    Auto-check passed
  • Commit

    shenjingnan/xiaozhi-client

    生成代码评审友好的 commit 信息

    341 GitHub stars~1.4k tokensUpdated 1 mo ago
    Auto-check passed
  • Dev Workflow Checker

    shenjingnan/xiaozhi-client

    开发流程检查技能,确保代码修改后执行必要的质量检查

    341 GitHub stars~464 tokensUpdated 1 mo ago
    Auto-check passed

Categories

Questions about Docs Creator

How do I install Docs Creator in Claude Code?

Run `npx skills add shenjingnan/xiaozhi-client --skill docs-creator -a claude-code`. Or copy the skill folder (.agents/skills/docs-creator in shenjingnan/xiaozhi-client) into .claude/skills/docs-creator in your project. Claude Code loads it when a task matches its description.

How do I install Docs Creator in Codex?

Run `npx skills add shenjingnan/xiaozhi-client --skill docs-creator -a codex`. Or copy the skill folder (.agents/skills/docs-creator in shenjingnan/xiaozhi-client) into .agents/skills/docs-creator in your project. Codex loads it when a task matches its description.

Can I use Docs Creator in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add shenjingnan/xiaozhi-client --skill docs-creator -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-creator, .gemini/skills/docs-creator, .github/skills/docs-creator and .opencode/skills/docs-creator in your project.

What does Docs Creator need to run?

Going by SKILL.md and its folder, Docs Creator needs the command-line tools its instructions call (pnpm, curl and npm).

Does Docs Creator access the network?

SKILL.md contains no URLs. Its commands use curl and npm, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Docs Creator safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Docs Creator use?

Docs Creator is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs Creator use?

About 614 tokens (SKILL.md is roughly 2.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Docs Creator?

Skills that share tags, products or a category with Docs Creator: MCP Server Builder (anthropics/skills, 180k stars), MCP Server Builder (shareAI-lab/learn-claude-code, 78k stars), MCP Integration for Plugins (anthropics/claude-plugins-official, 38k stars) and Crush Configuration (charmbracelet/crush, 29k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Creator?

shenjingnan (a GitHub user) maintains it in shenjingnan/xiaozhi-client, which has 341 GitHub stars. The repository holds 16 skills in this directory. The repository was last updated on September 3, 2026.

Source: shenjingnan/xiaozhi-client on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.