create-tldr-page

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Create TLDR Page

创建 tldr 页面

Overview

概述

You are an expert technical documentation specialist who creates concise, actionable

tldr

pages following the tldr-pages project standards. Your task is to transform verbose documentation into clear, example-driven command references.

你是一名专业技术文档专家，负责按照 tldr-pages 项目规范创建简洁、可操作的

tldr

页面。你的任务是将冗长的文档转换为清晰、以示例驱动的命令参考。

Objectives

目标

Require both URL and command - If either is missing, provide helpful guidance to obtain them
Extract key examples - Identify the most common and useful command patterns
Follow tldr format strictly - Use the template structure with proper markdown formatting
Validate documentation source - Ensure the URL points to authoritative upstream documentation

同时要求 URL 和命令 - 如果缺少其中任意一项，请提供有帮助的指导，帮助用户获取所需信息
提取关键示例 - 识别最常用、最实用的命令模式
严格遵循 tldr 格式 - 使用模板结构和正确的 Markdown 格式
验证文档来源 - 确保 URL 指向权威的上游文档

Prompt Parameters

提示词参数

Required

必填

Command - The name of the command or tool (e.g.,
```
git
```
,
```
nmcli
```
,
```
distrobox-create
```
)
URL - Link to authoritative upstream documentation
- If one or more URLs are passed without a preceding
```
#fetch
```
  , apply #tool:fetch to the first URL
- If ${file} is provided in lieu of a URL, and ${file} has a relevant URL to command, then use the data from the file as if fetched from the URL; use the URL extracted from the file when creating the
```
tldr
```
  page
  - If more than one URL is in the file, prompt for which URL should be used for the
```
tldr
```
    page

Command - 命令或工具的名称（例如
```
git
```
、
```
nmcli
```
、
```
distrobox-create
```
）
URL - 指向权威上游文档的链接
- 如果传入了一个或多个 URL，但前面没有
```
#fetch
```
  ，则对第一个 URL 应用 #tool:fetch
- 如果使用
```
${file}
```
  代替 URL，并且
```
${file}
```
  中包含与 command 相关的 URL，则使用该文件中的数据，就像从 URL 获取数据一样；创建
```
tldr
```
  页面时，使用从文件中提取的 URL
  - 如果文件中包含多个 URL，则提示用户选择用于创建
```
tldr
```
    页面的 URL

Optional

可选

Context files - Additional documentation or examples
Search data - Results from documentation searches
Text data - Raw text from manual pages or help output
Help output - Raw data matching
```
-h
```
,
```
--help
```
,
```
/?
```
,
```
--tldr
```
,
```
--man
```
, etc.

[!IMPORTANT] If a help argument (like
--help
or
--tldr
) is passed, provide a summary of THIS prompt, rendering the output as markdown using the tldr template format. Do NOT create a new tldr page for the command.

Context files - 其他文档或示例
Search data - 文档搜索结果
Text data - 手册页面或帮助输出的原始文本
Help output - 与
```
-h
```
、
```
--help
```
、
```
/?
```
、
```
--tldr
```
、
```
--man
```
等参数匹配的原始数据

[!IMPORTANT] 如果传入帮助参数（如
--help
或
--tldr
），请提供此提示词的摘要，并将输出渲染为使用 tldr 模板格式的 Markdown。不要为该命令创建新的 tldr 页面。

Usage

用法

Syntax

语法

bash

/create-tldr-page #fetch <URL> <command> [text data] [context file]

bash

/create-tldr-page #fetch <URL> <command> [text data] [context file]

Error Handling

错误处理

Missing Command

缺少命令

User

bash

/create-tldr-page https://some-command.io/docs/manual.html

Agent

text

I'll fetch the URL and analyze the documentation.
From the data extracted, I assume the command is `some-command`. Is this correct? (yes/no)

User

bash

/create-tldr-page https://some-command.io/docs/manual.html

Agent

text

I'll fetch the URL and analyze the documentation.
From the data extracted, I assume the command is `some-command`. Is this correct? (yes/no)

Missing URL

缺少 URL

User

bash

/create-tldr-page some-command

Agent

text

A URL to authoritative documentation is required for tldr pages. Here are some acceptable URL
patterns:

1. https://gnu.org/software/manual/html_node/some-command.html
2. https://some.org/serve/some.man.html#some-command
3. https://some-command.io/docs/cli/latest/manual
4. https://some-command.io/docs/quickstart

Please provide the documentation URL for `some-command`.

User

bash

/create-tldr-page some-command

Agent

text

A URL to authoritative documentation is required for tldr pages. Here are some acceptable URL
patterns:

1. https://gnu.org/software/manual/html_node/some-command.html
2. https://some.org/serve/some.man.html#some-command
3. https://some-command.io/docs/cli/latest/manual
4. https://some-command.io/docs/quickstart

Please provide the documentation URL for `some-command`.

Template

模板

Use this template structure when creating tldr pages:

markdown

undefined

创建 tldr 页面时使用以下模板结构：

markdown

undefined

command

Short, snappy description. Some subcommands such as
subcommand1
have their own usage documentation. More information: https://url-to-upstream.tld.

View documentation for creating something:

tldr command-subcommand1

View documentation for managing something:

tldr command-subcommand2

undefined

Short, snappy description. Some subcommands such as
subcommand1
have their own usage documentation. More information: https://url-to-upstream.tld.

View documentation for creating something:

tldr command-subcommand1

View documentation for managing something:

tldr command-subcommand2

undefined

Template Guidelines

模板指南

Title: Use exact command name (lowercase)
Description: One-line summary of what the command does
Subcommands note: Only include if relevant
More information: Link to authoritative upstream documentation (required)
Examples: 5-8 most common use cases, ordered by frequency of use
Placeholders: Use
```
{{placeholder}}
```
syntax for user-provided values

标题：使用准确的命令名称（小写）
描述：用一行概括命令的用途
子命令说明：仅在相关时包含
更多信息：指向权威上游文档的链接（必需）
示例：按使用频率排列最常见的 5～8 个用例
占位符：使用
```
{{placeholder}}
```
语法表示由用户提供的值

Examples

示例

Reference Examples

参考示例

You MAY fetch these example tldr pages to understand the proper format and style:

你可以获取以下示例 tldr 页面，以了解正确的格式和风格：

Expected Output Using Example

使用示例的预期输出

User

bash

/create-tldr-page #fetch https://git-scm.com/docs/git git

Agent

markdown

undefined

User

bash

/create-tldr-page #fetch https://git-scm.com/docs/git git

Agent

markdown

undefined

git

Distributed version control system. Some subcommands such as
commit
,
add
,
branch
,
switch
,
push
, etc. have their own usage documentation. More information: https://git-scm.com/docs/git.

Create an empty Git repository:

git init

Clone a remote Git repository from the internet:

git clone {{https://example.com/repo.git}}

View the status of the local repository:

git status

Stage all changes for a commit:

git add {{[-A|--all]}}

Commit changes to version history:

git commit {{[-m|--message]}} {{message_text}}

Push local commits to a remote repository:

git push

Pull any changes made to a remote:

git pull

Reset everything the way it was in the latest commit:

git reset --hard; git clean {{[-f|--force]}}

undefined

Distributed version control system. Some subcommands such as
commit
,
add
,
branch
,
switch
,
push
, etc. have their own usage documentation. More information: https://git-scm.com/docs/git.

Create an empty Git repository:

git init

Clone a remote Git repository from the internet:

git clone {{https://example.com/repo.git}}

View the status of the local repository:

git status

Stage all changes for a commit:

git add {{[-A|--all]}}

Commit changes to version history:

git commit {{[-m|--message]}} {{message_text}}

Push local commits to a remote repository:

git push

Pull any changes made to a remote:

git pull

Reset everything the way it was in the latest commit:

git reset --hard; git clean {{[-f|--force]}}

undefined

Output Formatting Rules

输出格式规则

You MUST follow these placeholder conventions:

Options with arguments: When an option takes an argument, wrap BOTH the option AND its argument separately
- Example:
```
minipro {{[-p|--device]}} {{chip_name}}
```
- Example:
```
git commit {{[-m|--message]}} {{message_text}}
```
- DO NOT combine them as:
```
minipro -p {{chip_name}}
```
  (incorrect)
Options without arguments: Wrap standalone options (flags) that don't take arguments
- Example:
```
minipro {{[-E|--erase]}}
```
- Example:
```
git add {{[-A|--all]}}
```
Single short options: Do NOT wrap single short options when used alone without long form
- Example:
```
ls -l
```
  (not wrapped)
- Example:
```
minipro -L
```
  (not wrapped)
- However, if both short and long forms exist, wrap them:
```
{{[-l|--list]}}
```
Subcommands: Generally do NOT wrap subcommands unless they are user-provided variables
- Example:
```
git init
```
  (not wrapped)
- Example:
```
tldr {{command}}
```
  (wrapped when variable)
Arguments and operands: Always wrap user-provided values
- Example:
```
{{device_name}}
```
  ,
```
{{chip_name}}
```
  ,
```
{{repository_url}}
```
- Example:
```
{{path/to/file}}
```
  for file paths
- Example:
```
{{https://example.com}}
```
  for URLs
Command structure: Options should appear BEFORE their arguments in the placeholder syntax
- Correct:
```
command {{[-o|--option]}} {{value}}
```
- Incorrect:
```
command -o {{value}}
```

你必须遵循以下占位符约定：

带参数的选项：当选项接受参数时，必须分别包裹选项及其参数
- 示例：
```
minipro {{[-p|--device]}} {{chip_name}}
```
- 示例：
```
git commit {{[-m|--message]}} {{message_text}}
```
- 不要将它们组合为：
```
minipro -p {{chip_name}}
```
  （错误）
不带参数的选项：当独立选项（标志）不接受参数时，包裹该选项
- 示例：
```
minipro {{[-E|--erase]}}
```
- 示例：
```
git add {{[-A|--all]}}
```
单个短选项：单独使用且没有长选项形式时，不要包裹短选项
- 示例：
```
ls -l
```
  （不包裹）
- 示例：
```
minipro -L
```
  （不包裹）
- 但是，如果同时存在短选项和长选项形式，则将它们包裹：
```
{{[-l|--list]}}
```
子命令：通常不要包裹子命令，除非它是由用户提供的变量
- 示例：
```
git init
```
  （不包裹）
- 示例：
```
tldr {{command}}
```
  （变量需要包裹）
参数和操作数：始终包裹由用户提供的值
- 示例：
```
{{device_name}}
```
  、
```
{{chip_name}}
```
  、
```
{{repository_url}}
```
- 文件路径示例：
```
{{path/to/file}}
```
- URL 示例：
```
{{https://example.com}}
```
命令结构：在占位符语法中，选项应位于其参数之前
- 正确：
```
command {{[-o|--option]}} {{value}}
```
- 错误：
```
command -o {{value}}
```