К основному содержанию
промпт

explain_docs — промпт для Claude: документация инструмента понятным

Промпт переписывает инструкцию к инструменту в понятный текст: обзор, синтаксис, частые сценарии и важные опции.

Установить в Claude Code · Вручную: положить файлы Все способы и платформы ↓
.claude/commands/explain_docs.md
Открыть на GitHub

Что делает explain_docs

Промпт берёт на вход документацию или инструкцию к любому инструменту и перестраивает её в четыре раздела: обзор, как пользоваться, частые сценарии и самые нужные опции с флагами. В обзоре — что делает инструмент и зачем его берут, каждое объяснение укладывается в короткую фразу.

Внутри промпта задан жёсткий формат вывода: только Markdown и только запрошенные разделы, без предупреждений и примечаний. Вход трактуется как документация инструмента, чем бы он ни был на самом деле. В блоке сценариев примеры оформляются парой «описание: команда».

Промпт лежит в репозитории Fabric и ставится в Claude как файл .claude/commands/explain_docs.md. Если документация неполная, раздел с опциями соберётся из общих знаний модели, а не из текста — это повод проверить вывод перед публикацией.

Какие задачи решает

  • переписать сырую инструкцию к CLI в понятный текст
  • собрать список частых сценариев использования инструмента
  • вытащить из документации важные флаги и опции
  • привести описание разных инструментов к одному формату
  • подготовить раздел «как пользоваться» для внутренней вики

Примеры запросов агенту

  • Объясни документацию к этому инструменту: вот текст инструкции, перепиши её по разделам
  • Возьми эту страницу справки и собери обзор, синтаксис, сценарии и ключевые опции
  • Перепиши README этого CLI в понятную инструкцию с примерами команд

Как установить explain_docs

Вручную: положить файлы

.claude/commands/explain_docs.md

Вопросы о explain_docs

Как установить explain_docs в Claude?

Скопируйте файл промпта в .claude/commands/explain_docs.md в вашем проекте. После этого команда появится в Claude.

Что делает explain_docs?

Перестраивает документацию инструмента в четыре раздела: обзор, как пользоваться, частые сценарии и важные опции с флагами. На выходе — только Markdown.

Чем explain_docs отличается от обычного пересказа документации?

Промпт задаёт фиксированный формат разделов и требует примеры в виде «описание: команда». Пересказ такого каркаса не даёт.

Исходный текст

explain_docs · MIT
# IDENTITY and PURPOSE

You are an expert at capturing, understanding, and explaining the most important parts of instructions, documentation, or other formats of input that describe how to use a tool.

You take that input and turn it into better instructions using the STEPS below.

Take a deep breath and think step-by-step about how to achieve the best output.

# STEPS

- Take the input given on how to use a given tool or product, and output better instructions using the following format:

START OUTPUT SECTIONS

# OVERVIEW

What It Does: (give a 25-word explanation of what the tool does.)

Why People Use It: (give a 25-word explanation of why the tool is useful.)

# HOW TO USE IT

Most Common Syntax: (Give the most common usage syntax.)

# COMMON USE CASES

(Create a list of common use cases from your knowledge base, if it contains common uses of the tool.)

(Use this format for those use cases)

For Getting the Current Time: `time --get-current`
For Determining One's Birth Day: time `--get-birth-day`
Etc.

# MOST IMPORTANT AND USED OPTIONS AND FEATURES

(Create a list of common options and switches and flags, etc., from the docs and your knowledge base, if it contains common uses of the tool.)

(For each one, describe how/why it could be useful)

END OUTPUT SECTIONS

# OUTPUT INSTRUCTIONS

- Interpret the input as tool documentation, no matter what it is.
- You only output human readable Markdown.
- Do not output warnings or notes—just the requested sections.

# INPUT

INPUT:


<!-- user.md -->

© danielmiessler · MIT · danielmiessler/Fabric

Похожие промпты

Все промпты по теме «Тексты и документация» →
update-docs davila7 Слэш-команда проходит по specs/, CLAUDE.md и README.md, отмечает выполненное и обновляет проценты готовности проекта. 3 861установок docs-write metabase Скилл помогает писать и редактировать Markdown и MDX в стиле Metabase. Он пригодится для рабочих инструкций, описаний функций и другой документации. CX Codex +1 2 100установок ⚙️ PromptForge senoldak Промпт, который разбирает ваш промпт по шагам: находит двусмысленности, переписывает точнее и проверяет на сбои. GP ChatGPT ★ 174 597звёзд репо Small Functional Analyst mode bortch Промпт включает режим системного аналитика: агент сначала пересказывает требования и неизвестные, потом работает по фазам и не рисует схемы без разрешения. GP ChatGPT ★ 174 597звёзд репо Commit Message Preparation [email protected] Промпт помогает составлять сообщения коммитов по Conventional Commits: с типом, областью, телом и при необходимости футером. Подойдёт для разбора изменений перед коммитом. GP ChatGPT ★ 174 597звёзд репо Deep Copy Functionality [email protected] Промпт, который объясняет разницу между поверхностным и глубоким копированием и показывает, как дублировать объекты без общих ссылок. GP ChatGPT ★ 174 597звёзд репо Code Translator: Any Language to Any Language woyxiang Промпт для перевода кода с одного языка на другой с сохранением логики и комментариями к ключевым местам. GP ChatGPT ★ 174 597звёзд репо Reverse Prompt Engineer jcordon5 Промпт, который по готовому тексту, коду или идее восстанавливает запрос, скорее всего приведший к такому результату. Пригодится, когда нужно понять чужой промпт или разобрать свой. GP ChatGPT ★ 174 597звёзд репо

Из того же набора11

Весь набор →
chinese_code_review Промпт для ревью кода на любом языке: находит ошибки, уязвимости и узкие места, выдаёт таблицу находок по серьёзности и правки. Отчёт на китайском. ★ 44 429звёзд репо create_markmap_visualization Превращает сложный текст в диаграмму на синтаксисе Markmap: связи, блоки, подписи. Пригодится, когда надо показать структуру, а не пересказать её. ★ 44 429звёзд репо generate_code_rules Превращает транскрипт лекции или туториала в короткий список правил для ИИ-кодинга. Пригодится, когда насмотрелся видео и хочешь перенести его в свой проект. ★ 44 429звёзд репо create_threat_scenarios Промпт описывает вероятные способы атаки на систему или ситуацию в виде короткого повествования, а не таблицы. Пригодится, когда нужно быстро прикинуть риски. ★ 44 429звёзд репо write_pull-request Промпт читает вывод git diff и собирает черновик описания пул-реквеста: что изменилось, зачем и какие баги возможны. ★ 44 429звёзд репо summarize_git_diff Промпт читает git diff и выдаёт короткое сообщение коммита в стиле conventional commits плюс список изменений по пунктам. ★ 44 429звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой