writing-doc-summaries

Official

Write precise 115–145 character summaries for docs.

Authorpingcap
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps maintain accurate and consistent YAML front matter by creating or updating the 115–145 character summary for Markdown docs in pingcap/docs and pingcap/docs-cn, ensuring discoverability and compliance with documentation guidelines.

Core Features & Use Cases

  • Generates compliant 115–145 character summaries that pass length requirements and opening-verb guidance.
  • Updates existing summaries to reflect the document scope and tone, without repeating the title.
  • Applies to files missing a summary or with low-quality or outdated summaries across docs and docs-cn.

Quick Start

Target a Markdown document and the skill will generate and insert a compliant summary into its front matter.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: writing-doc-summaries
Download link: https://github.com/pingcap/docs-staging/archive/main.zip#writing-doc-summaries

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.