explain_docs — промпт для Claude: документация инструмента понятным
Промпт переписывает инструкцию к инструменту в понятный текст: обзор, синтаксис, частые сценарии и важные опции.
.claude/commands/explain_docs.mdЧто делает explain_docs
Промпт берёт на вход документацию или инструкцию к любому инструменту и перестраивает её в четыре раздела: обзор, как пользоваться, частые сценарии и самые нужные опции с флагами. В обзоре — что делает инструмент и зачем его берут, каждое объяснение укладывается в короткую фразу.
Внутри промпта задан жёсткий формат вывода: только Markdown и только запрошенные разделы, без предупреждений и примечаний. Вход трактуется как документация инструмента, чем бы он ни был на самом деле. В блоке сценариев примеры оформляются парой «описание: команда».
Промпт лежит в репозитории Fabric и ставится в Claude как файл .claude/commands/explain_docs.md. Если документация неполная, раздел с опциями соберётся из общих знаний модели, а не из текста — это повод проверить вывод перед публикацией.
Какие задачи решает
- переписать сырую инструкцию к CLI в понятный текст
- собрать список частых сценариев использования инструмента
- вытащить из документации важные флаги и опции
- привести описание разных инструментов к одному формату
- подготовить раздел «как пользоваться» для внутренней вики
Примеры запросов агенту
- Объясни документацию к этому инструменту: вот текст инструкции, перепиши её по разделам
- Возьми эту страницу справки и собери обзор, синтаксис, сценарии и ключевые опции
- Перепиши README этого CLI в понятную инструкцию с примерами команд
Как установить explain_docs
Вручную: положить файлы
.claude/commands/explain_docs.mdКак использовать
Вставьте текст в начало диалога или в инструкции проекта
Команда из источника
fabric --pattern explain_docsВопросы о 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