К основному содержанию
команда CX Codex

create-readme-section — команда для Claude Code

Команда create-readme-section для автоматической генерации структурированных секций README: установка, API, документация, вклад в проект. Экономит время на форматирование и соответствие best practices.

MIT ★ 2 744 обновлён 2026-10-08

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

Что делает create-readme-section

Команда запускает Claude на создание отдельной секции README по вашему запросу — неважно, нужна вам инструкция по установке, описание API, гайд для контрибьюторов или раздел про развёртывание. Claude анализирует существующие файлы проекта (package.json, requirements.txt и прочие), чтобы подхватить контекст, и генерирует секцию в стиле уже написанного README.

При создании секции команда следует шаблонам: для Installation добавляет предусловия, пошаговые шаги и проверку; для Usage — примеры кода с выводом; для API Reference — описание эндпоинтов, форматы запросов и ошибки. Результат с правильными заголовками, блоками кода и списками можно сразу вставить в файл.

Команда доступна в Claude Code через .claude/commands/create-readme-section.md; если вы пользуетесь Codex, GitHub Copilot или Gemini CLI, там свои пути установки.

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

  • сгенерировать раздел установки для Python-проекта
  • написать секцию API с примерами запросов и ошибками
  • создать гайд для контрибьюторов в стиле существующего README
  • подготовить раздел про конфигурацию с переменными окружения
  • оформить troubleshooting-секцию с частыми проблемами

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

  • Создай раздел установки для моего проекта на Python
  • Напиши секцию API Reference для REST эндпоинтов с примерами
  • Сгенерируй гайд Contributing, соответствующий стилю README

Как установить create-readme-section

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

.claude/commands/create-readme-section.md

Вызов — /create-readme-section. Для всех проектов — ~/.claude/commands/

Вопросы о create-readme-section

Как установить create-readme-section в Claude Code?

Создайте файл .claude/commands/create-readme-section.md в корне проекта с телом команды. Затем в Claude Code можно будет вызвать эту команду через меню или поиск.

Что делает create-readme-section?

Команда генерирует структурированную секцию README на основе вашего запроса — установку, документацию API, гайд для контрибьюторов и так далее. Claude анализирует проект и создаёт текст по best practices.

Поддерживается ли create-readme-section на других платформах?

Да, команда доступна для Codex (~/.codex/prompts/create-readme-section.md), GitHub Copilot (.github/prompts/create-readme-section.prompt.md) и Gemini CLI (.gemini/commands/create-readme-section.toml). Пути установки разные для каждой платформы.

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

create-readme-section.md · MIT
# Create README Section

Generate a specific section for a README file based on the user's request. This command helps create well-structured, professional README sections that follow best practices.

## Usage Examples

### Basic Usage
"Create an installation section for my Python project"
"Generate a contributing guide section"
"Write an API reference section for my REST endpoints"

### Specific Sections
- **Installation**: Step-by-step setup instructions
- **Usage**: How to use the project with examples
- **API Reference**: Detailed API documentation
- **Contributing**: Guidelines for contributors
- **License**: License information
- **Configuration**: Configuration options and environment variables
- **Troubleshooting**: Common issues and solutions
- **Dependencies**: Required dependencies and versions
- **Architecture**: High-level architecture overview
- **Testing**: How to run tests
- **Deployment**: Deployment instructions
- **Changelog**: Version history and changes

## Instructions for Claude

When creating a README section:

1. **Analyze the Project Context**: Look at existing files (package.json, requirements.txt, etc.) to understand the project
2. **Follow Markdown Best Practices**: Use proper headings, code blocks, and formatting
3. **Include Practical Examples**: Add code snippets and command examples where relevant
4. **Be Comprehensive but Concise**: Cover all important points without being verbose
5. **Match Existing Style**: If a README already exists, match its tone and formatting style

### Section Templates

#### Installation Section
- Prerequisites
- Step-by-step installation
- Verification steps
- Common installation issues

#### Usage Section
- Basic usage examples
- Advanced usage scenarios
- Command-line options (if applicable)
- Code examples with expected output

#### API Reference Section
- Endpoint descriptions
- Request/response formats
- Authentication details
- Error codes and handling
- Rate limiting information

#### Contributing Section
- Development setup
- Code style guidelines
- Pull request process
- Issue reporting guidelines
- Code of conduct reference

### Output Format

Generate the section with:
- Appropriate heading level (usually ## or ###)
- Clear, structured content
- Code blocks with language specification
- Links to relevant resources
- Bullet points or numbered lists where appropriate

Remember to ask for clarification if the section type or project details are unclear.

© centminmod · MIT · centminmod/my-claude-code-setup

Похожие слэш-команды

Все слэш-команды по теме «Тексты и документация» →
create-readme официальный github Скилл create-readme для GitHub Copilot изучает проект и создаёт структурированный README.md. Собирает документацию по коду и файлам проекта. CX Codex +1 19 081установок readme-blueprint-generator официальный github Скилл readme-blueprint-generator для GitHub Copilot собирает сведения из документации проекта и готовит структурированный README.md. Основа README — материалы из .github/copilot и copilot-instructions.md. CX Codex +1 9 662установок indexion-readme trkbt10 Скилл indexion-readme собирает README из шаблонов, doc-комментариев и статических файлов, а потом проверяет, что правки ничего не удалили. CX Codex +1 5 100установок readme-generator Jeremy Longshore Скилл для автоматической генерации README-файлов в проектах. Активируется по фразе «readme generator» или «readme» в запросе. CX Codex +1 273установок readme-updater alirezarezvani Скилл readme-updater обновляет README автоматически, когда меняется структура проекта, добавляются зависимости или новые фичи. CX Codex +1 ★ 788звёзд репо update-readme Samarth Gupta Скилл update-readme для Claude Code обновляет существующий README.md по текущему состоянию кода, истории git и CHANGELOG. Обновляет документацию, сверяя её с проектом. CX Codex +1 ★ 276звёзд репо

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

Весь набор →
04_stack_trace_debug Промпт 04_stack_trace_debug для Claude Code: находит первопричину Python stack trace, называет проблемный вызов и предлагает исправление. Разбирает вставленный traceback. GP ChatGPT ★ 2 744звёзд репо 07_json_reshape Промпт 07_json_reshape перестраивает JSON-образец под рубрику: на выходе массив записей с тремя полями и суммой по позициям. GP ChatGPT ★ 2 744звёзд репо 03_code_review Промпт 03_code_review для ревью Python-диффов. Требует найти ровно три проблемы и выдать их кратким списком без вводных слов и заголовков. GP ChatGPT ★ 2 744звёзд репо ccusage-daily Команда запускает ccusage daily -b и превращает статистику Claude Code в отчёт с расходами, токенами и разбивкой по дням. Пригодится, чтобы разобрать затраты за период. CX Codex +1 ★ 2 744звёзд репо 01_claudemd_summarise Промпт 01_claudemd_summarise для Claude Code сжимает CLAUDE.md в ровно 120 слов — один абзац без списков. Стандартизирует описание архитектуры проекта для контекста ИИ-ассистента. GP ChatGPT ★ 2 744звёзд репо security-audit Команда security-audit проверяет кодовую базу на уязвимости и небезопасные шаблоны. Попросите её изучить весь проект или отдельный модуль. CX Codex +1 ★ 2 744звёзд репо check-best-practices Команда check-best-practices проверяет код на соответствие языковым стандартам, конвенциям и best practices. Помогает улучшить качество и поддерживаемость кода, выявляя проблемы от критических до стилистических. CX Codex +1 ★ 2 744звёзд репо claude-docs-consultant Скилл claude-docs-consultant загружает официальные страницы документации Claude Code с сайта code.claude.com под конкретную задачу. Без скачивания лишних файлов и устаревшего кэша. CX Codex +1 ★ 2 744звёзд репо

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

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