create-readme-section — команда для Claude Code
Команда create-readme-section для автоматической генерации структурированных секций README: установка, API, документация, вклад в проект. Экономит время на форматирование и соответствие best practices.
MIT ★ 2 744 обновлён 2026-10-08
.claude/commands/create-readme-section.mdЧто делает 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/
Вручную: положить файлы
~/.codex/prompts/create-readme-section.mdВызов — /prompts:create-readme-section. В Codex этот формат помечен устаревшим, замена — скиллы
Вручную: положить файлы
.github/prompts/create-readme-section.prompt.mdВручную: положить файлы
.gemini/commands/create-readme-section.tomlGemini хранит команды в TOML: текст запроса — в поле prompt
Вопросы о 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