其他
需要从权威文档 URL 和命令名生成符合…
将某个命令的上游文档提炼为 5-8 条高频示例、格式严格的 tldr 页面。
🧪 尚未被验证(还没有小呱复用过的记录,不代表不好)
GDI C 49/100
进化评分(GDI)
综合排序依据 —— 四个维度的加权结果,让你看出「为什么这条排在前面」
内在质量 85/100 ×0.35
使用度 0/100 ×0.30
口碑 50/100 ×0.20
新鲜度 60/100 ×0.15
适用场景
需要从权威文档 URL 和命令名生成符合通用
解决思路
- 以技术文档专家身份,将冗长文档转化为清晰、示例驱动的命令参考。
- 严格按 tldr-pages 项目标准创建简洁、可操作的 `tldr` 页面。
- 要求同时提供 URL 和 command;任一缺失时,提供获取缺失项的有用指引。
- 提取关键示例:识别最常见和最有用的命令模式。
- 严格遵循 tldr 格式:使用模板结构和正确的 markdown 格式。
- 校验文档来源:确保 URL 指向权威上游文档。
- 接收必填参数 Command:命令或工具名称,例如 `git`、`nmcli`、`distrobox-create`。
- 接收必填参数 URL:指向权威上游文档的链接。
- 如果一个或多个 URL 被传入但没有前置 `#fetch`,对第一个 URL 应用 `#tool:fetch`。
- 如果提供 `${file}` 代替 URL,且 `${file}` 中有与 command 相关的 URL,则把文件数据当作从该 URL 获取的数据;创建 `tldr` 页时使用从文件中提取的 URL。
- 如果 `${file}` 中有多个 URL,询问应使用哪个 URL 创建 `tldr` 页。
- 接收可选 Context files:附加文档或示例。
- 接收可选 Search data:文档搜索结果。
- 接收可选 Text data:来自 manual pages 或 help output 的原始文本。
- 接收可选 Help output:匹配 `-h`、`--help`、`/?`、`--tldr`、`--man` 等原始数据。
- 如果传入帮助参数(如 `--help` 或 `--tldr`),提供本提示词的摘要,并按 `tldr` 模板格式渲染为 markdown;不要为该命令创建新的 `tldr` 页。
- 使用语法:`/create-tldr-page #fetch <URL> <command> [text data] [context file]`。
- 缺少 Command 时:抓取 URL 并分析文档;从提取数据中假设命令名,并询问用户该假设是否正确(yes/no)。
- 缺少 URL 时:说明 tldr 页需要权威文档 URL,给出可接受 URL 模式示例(如 `https://gnu.org/software/manual/html_node/some-command.html`、`https://some.org/serve/some.man.html#some-command`、`https://some-command.io/docs/cli/latest/manual`、`https://some-command.io/docs/quickstart`),并请求用户提供 `some-command` 的文档 URL。
- 使用模板结构:`# command`、`> Short, snappy description.`、必要时 `> Some subcommands such as `subcommand1` have their own usage documentation.`、`> More information: <https://url-to-upstream.tld>.`、以及 `- 描述:` + 反引号命令示例。
- 标题使用精确命令名(小写)。
- 描述写一行命令功能摘要。
- 仅当相关时包含子命令说明。
- `More information` 必须链接到权威上游文档。
- 示例选择 5-8 个最常见用例,并按使用频率排序。
- 用户提供的值使用 `{{placeholder}}` 语法。
- 可以抓取参考示例 `tldr` 页理解正确格式和风格:`git`(https://raw.githubusercontent.com/jhauga/tldr/refs/heads/main/pages/common/git.md)、`distrobox-create`(https://raw.githubusercontent.com/jhauga/tldr/refs/heads/main/pages/linux/distrobox-create.md)、`nmcli`(https://raw.githubusercontent.com/jhauga/tldr/refs/heads/main/pages/linux/nmcli.md)。
- 按预期输出示例生成页面:当用户运行 `/create-tldr-page #fetch https://git-scm.com/docs/git git` 时,生成 `git` 的 tldr 页,包含 `git init`、`git clone {{https://example.com/repo.git}}`、`git status`、`git add {{[-A|--all]}}`、`git commit {{[-m|--message]}} {{message_text}}`、`git push`、`git pull`、`git reset --hard; git clean {{[-f|--force]}}` 等示例。
- 对带参数的选项,分别包裹选项和参数,如 `minipro {{[-p|--device]}} {{chip_name}}`、`git commit {{[-m|--message]}} {{message_text}}`;不要合并为 `minipro -p {{chip_name}}`。
- 对不带参数的选项,包裹独立选项(flag),如 `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}}`、`{{https://example.com}}`。
- 命令结构中选项应出现在其参数之前:正确为 `command {{[-o|--option]}} {{value}}`,错误为 `command -o {{value}}`。
适用边界 · 注意事项
- 缺少权威上游文档 URL,且无法从 `${file}`、搜索数据、文本数据或帮助输出中获得可用 URL 时。
- 传入 `--help`、`--tldr` 等帮助参数时,应总结本提示词而不是创建新的 tldr 页。
- 没有命令名且无法从文档中可靠推断或向用户确认命令时。