Agent skill

Write Update Tidb Docs

by pingcap in pingcap/docs

Write new TiDB documentation or update existing TiDB documentation from code changes, PRs, issues, design docs, product specs, rough drafts, existing docs, or short feature descriptions.

Custom licenceAuto-check passedProduct & Project Management

Install Write Update Tidb Docs

skills CLI
$ npx skills add pingcap/docs --skill write-update-tidb-docs -a claude-code

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

GitHub CLI
$ gh skill install pingcap/docs write-update-tidb-docs --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/pingcap/docs.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/write-update-tidb-docs .claude/skills/write-update-tidb-docs && 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
write-update-tidb-docs
GitHub stars
616
Token cost
~2.3k tokens
SKILL.md length
1,068 words
Files
3
Skills in repo
8
Repo updated
First seen
Licence
Custom licence

At a glance

Write new TiDB documentation or update existing TiDB documentation from code changes, PRs, issues, design docs, product specs, rough drafts, existing docs, or short feature descriptions.

  • Works in 4 steps: Load shared context → Analyze the input → Determine the target branch and version → …
  • R&D engineers need user-facing docs in pingcap/docs based on code PRs from pingcap/tidb
  • SKILL.md covers Quick start, Ground every fact in the source, Accepted inputs and Defaults, plus 8 more sections
  • Calls gh and git

What it does

Write Update Tidb Docs is an agent skill from pingcap/docs. Write new TiDB documentation or update existing TiDB documentation from code changes, PRs, issues, design docs, product specs, rough drafts, existing docs, or short feature descriptions. Use when PM or R&D engineers need user-facing docs in pingcap/docs based on code PRs from pingcap/tidb or other TiDB ecosystem repositories, GitHub issues, product specifications, or external reference materials.

Its SKILL.md is about 2.3k tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files (for example `ref-create-new-doc.md` and `ref-update-existing-doc.md`).

It sits in Product & Project Management, covering PRD writing and Architecture decision records. It works with TiDB and GitHub. The repository describes itself as: TiDB database documentation. TiDB is an open-source, cloud-native, distributed, MySQL-Compatible database for elastic scale and real-time analytics.

When your agent uses it

  • R&D engineers need user-facing docs in pingcap/docs based on code PRs from pingcap/tidb
  • Other TiDB ecosystem repositories
  • Product specifications
  • External reference materials

Example prompts

  • “/write-update-tidb-docs”

Workflow steps

4 steps, taken from the step headings in SKILL.md.

  1. Load shared context
  2. Analyze the input
  3. Determine the target branch and version
  4. Decide — create new page or update existing

What it can do on your machine

Read from SKILL.md and the folder at commit 6ba8576. 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:

    • gh
    • git

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

  • Network

    No URLs in SKILL.md. Its commands use gh and git, 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

Write Update Tidb Docs loads about 2.3k tokens when it runs. Until then it costs about 106 tokens; SKILL.md has 1,068 words of instructions outside code blocks.

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

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

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 1,068 words (~2,251 tokens).

“Act as a senior technical writer who has profound knowledge of TiDB. Your task is to write or update user-facing TiDB documentation in pingcap/docs based on code changes, PRs, issues, design docs, product specs, rough drafts, existing docs, or short…”

— opening of SKILL.md by pingcap, Custom licence
name
write-update-tidb-docs

Read the full SKILL.md on GitHub

Files

SKILL.md and 2 other files in .agents/skills/write-update-tidb-docs of pingcap/docs.

  • SKILL.md
  • ref-create-new-doc.md
  • ref-update-existing-doc.md

Open the folder on GitHubat commit 6ba8576

Compare with similar skills

Write Update Tidb Docs 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.

Write Update Tidb Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Write Update Tidb Docs this skillpingcap/docs616—~2.3kAutomated safety check: PassCustom licence
CCPM Project Managementautomazeio/ccpm8.4k—~1.1kAutomated safety check: PassMIT
Rfc Modelingmirumee/nimara-ecommerce129—~920Automated safety check: PassBSD-3-Clause
Req Change Workflowyunshu0909/yunshu_skillshub766—~1.4kAutomated safety check: PassMIT
Create Product Specwarpdotdev/oz-for-oss313—~1.2kAutomated safety check: PassMIT
Create Product SpecTerry-Mao/AICodingFlow167—~1.3kAutomated safety check: PassMIT

Similar skills

  • Runs a spec-driven workflow from PRD to epic to GitHub issues to parallel agents, with status, standup and blocked-work reports from bundled scripts.

    8.4k GitHub stars~1.1k tokensUpdated 6 mo ago
    Product & Project ManagementAuto-check passed
  • Rfc Modeling

    mirumee/nimara-ecommerce

    A skill your agent uses when designing, drafting, refining, or stress-testing an RFC for an approved PRD, including requests for a design doc, solution design, or how to build it.

    129 GitHub stars~920 tokensUpdated yesterday
    Product & Project ManagementAuto-check passed
  • Req Change Workflow

    yunshu0909/yunshu_skillshub

    已有功能的需求变更闭环(门禁式七步)。触发硬条件:要改的功能已经实现并跑起来了。当用户说"改需求""需求变更""调整交互""改功能""重构流程",或改动容易散到多个文件、碰到鉴权/存储/配置/权限、需要可靠验证 + 回滚方案时使用。流程:锁 scope 写 change brief → 从代码确认当前行为(不靠记忆和假设)→ 影响面与风险评估 + 回滚计划 →…

    766 GitHub stars~1.4k tokensUpdated yesterday
    Product & Project ManagementAuto-check passed
  • Create Product Spec

    warpdotdev/oz-for-oss

    Create a product spec from a GitHub issue in this repository by applying the shared write-product-spec workflow with Oz-specific issue context and output paths.

    313 GitHub stars~1.2k tokensUpdated 20 days ago
    Product & Project ManagementAuto-check passed
  • Create Product Spec

    Terry-Mao/AICodingFlow

    Create a product spec from a GitHub issue in this repository by applying the local shared write-product-spec workflow with issue context and output paths.

    167 GitHub stars~1.3k tokensUpdated 4 days ago
    Product & Project ManagementAuto-check passed
  • Schematic

    blader/schematic

    Reverse engineer a detailed product and technical specification document from a git branch's implementation.

    239 GitHub stars~2.2k tokensUpdated 7 mo ago
    Product & Project ManagementAuto-check passed

More from pingcap/docs

All 8 skills in this repo
  • Produces and merges Related resources cards for TiDB docs pages using the RelatedResources and ResourceCard MDX components.

    616 GitHub stars~1.8k tokensUpdated today
    Auto-check passed
  • Release Notes

    pingcap/docs

    Evaluate whether a change needs a release note. An agent skill from pingcap/docs.

    616 GitHub stars~2.6k tokensUpdated today
    Auto-check passed
  • Create or update a zh translation PR from pingcap/docs to pingcap/docs-cn by using repo-local scripts to prepare change-unit translation inputs, apply minimal edits to the existing Chinese files…

    616 GitHub stars~2.9k tokensUpdated today
    Auto-check passed
  • Writes or updates the front matter summary field in pingcap/docs and pingcap/docs-cn Markdown files.

    616 GitHub stars~1.8k tokensUpdated today
    Auto-check passed
  • A skill your agent uses when creating or editing GitHub issues in pingcap/docs so issue templates, required fields, scope boundaries, and labels stay consistent with repository workflow.

    616 GitHub stars~1.8k tokensUpdated today
    Auto-check passed
  • A skill your agent uses when creating or editing pull requests in pingcap/docs so the PR template sections, version checkboxes, related-link fields, HTML comments, and description structure stay…

    616 GitHub stars~1.9k tokensUpdated today
    Auto-check passed

Works with

Questions about Write Update Tidb Docs

What does Write Update Tidb Docs do?

Write new TiDB documentation or update existing TiDB documentation from code changes, PRs, issues, design docs, product specs, rough drafts, existing docs, or short feature descriptions. Write Update Tidb Docs is an agent skill from pingcap/docs. Write new TiDB documentation or update existing TiDB documentation from code changes, PRs, issues, design docs, product specs, rough drafts, existing docs, or short feature descriptions.

When should I use Write Update Tidb Docs?

Write Update Tidb Docs fits situations like: R&D engineers need user-facing docs in pingcap/docs based on code PRs from pingcap/tidb; other TiDB ecosystem repositories; product specifications; external reference materials.

How do I install Write Update Tidb Docs in Claude Code?

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

How do I install Write Update Tidb Docs in Codex?

Run `npx skills add pingcap/docs --skill write-update-tidb-docs -a codex`. Or copy the skill folder (.agents/skills/write-update-tidb-docs in pingcap/docs) into .agents/skills/write-update-tidb-docs in your project. Codex loads it when a task matches its description.

Can I use Write Update Tidb Docs 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 pingcap/docs --skill write-update-tidb-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/write-update-tidb-docs, .gemini/skills/write-update-tidb-docs, .github/skills/write-update-tidb-docs and .opencode/skills/write-update-tidb-docs in your project.

What does Write Update Tidb Docs need to run?

Going by SKILL.md and its folder, Write Update Tidb Docs needs the command-line tools its instructions call (gh and git).

Does Write Update Tidb Docs access the network?

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

Is Write Update Tidb Docs 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 Write Update Tidb Docs use?

Write Update Tidb Docs has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Write Update Tidb Docs use?

About 2.3k tokens (SKILL.md is roughly 9k 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 Write Update Tidb Docs?

Skills that share tags, products or a category with Write Update Tidb Docs: CCPM Project Management (automazeio/ccpm, 8.4k stars), Rfc Modeling (mirumee/nimara-ecommerce, 129 stars), Req Change Workflow (yunshu0909/yunshu_skillshub, 766 stars) and Create Product Spec (warpdotdev/oz-for-oss, 313 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Write Update Tidb Docs?

pingcap (a GitHub organization) maintains it in pingcap/docs, which has 616 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on October 7, 2026.

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