Prompt Engineering Documentation

This repository contains comprehensive, structured documentation on prompt engineering, developed to standardize and optimize the work of prompt engineers across various organizations.

Documentation Structure

The repository includes the following key documents in both English and Russian:

Core Guidelines

• Prompt Engineering Techniques

  • PE_techniques_EN.md - Comprehensive guide to prompt engineering techniques
  • PE_techniques_RU.md - Russian version

• Prompt Task Categories

  • PE_task_categories_EN.md - Document describing task categorization in prompt engineering
  • PE_task_categories_RU.md - Russian version

• Product Prompting Guide

  • PE_product_guide_EN.md - Practical guidelines for writing prompts for product development
  • PE_product_guide_RU.md - Russian version

The techniques guide represents over six months of work collecting, analyzing, and structuring information from various sources. The AI assistant Claude played a significant role in systematizing and structuring accumulated knowledge and experience into cohesive, logically connected documents.

About the Project

This documentation is being developed as a universal foundation for organizing the work of prompt engineers in any company, startup, or project. The materials are constantly being supplemented and updated to reflect the current state of the industry and best practices.

Development Status

The current set of documents is under active development. We plan to supplement the repository with new materials, including:

• Practical guides for specific applications
• Library of prompt templates
• Implementation examples for various scenarios
• Detailed methodological recommendations
• Prompt testing and validation tools

Contributing

We welcome community contributions to improve this documentation. If you would like to contribute, please:

• Create issues with suggestions for improvement
• Submit pull requests with corrections and additions
• Share your experience applying these methodologies
• Participate in discussions

Language Versions

Starting from version 0.1.1, English is the primary language for all documentation. Russian translations are maintained for all core documents to ensure accessibility for Russian-speaking prompt engineers.

License

MIT

---

Документация по промпт-инжинирингу

Данный репозиторий содержит структурированную документацию по промпт-инжинирингу, разработанную для стандартизации и оптимизации работы промпт-инженеров в различных организациях.

Структура документации

Репозиторий включает следующие ключевые документы на английском и русском языках:

Основные руководства

• Техники промпт-инжиниринга

  • PE_techniques_EN.md - Всеобъемлющее руководство на английском языке
  • PE_techniques_RU.md - Русская версия

• Категории задач промпт-инжиниринга

  • PE_task_categories_EN.md - Документ на английском языке
  • PE_task_categories_RU.md - Русская версия

• Руководство по промптингу для продуктовой разработки

  • PE_product_guide_EN.md - Практическое руководство на английском языке
  • PE_product_guide_RU.md - Русская версия

Руководство по техникам является результатом более чем полугодовой работы по сбору, анализу и структуризации информации из различных источников. Особую роль в создании документации сыграл AI-ассистент Claude, который помог систематизировать и структурировать накопленные знания и опыт в единые, логически связные документы.

О проекте

Данная документация разрабатывается как универсальная основа для организации работы промпт-инженеров в любой компании, стартапе или проекте. Материалы постоянно дополняются и обновляются, отражая текущее состояние отрасли и лучшие практики.

Статус разработки

Текущий набор документов находится в активной разработке. Планируется дополнение репозитория новыми материалами, включая:

• Практические руководства по специфическим применениям
• Библиотеку шаблонов промптов
• Примеры реализации для различных сценариев
• Подробные методические рекомендации
• Инструменты тестирования и валидации промптов

Вклад в проект

Мы приветствуем вклад сообщества в развитие данной документации. Если вы хотите внести свой вклад, пожалуйста:

• Создавайте issues с предложениями по улучшению
• Предлагайте pull requests с исправлениями и дополнениями
• Делитесь опытом применения методик
• Участвуйте в обсуждениях

Языковые версии

Начиная с версии 0.1.1, английский язык является основным для всей документации. Русские переводы поддерживаются для всех основных документов, чтобы обеспечить доступность для русскоговорящих промпт-инженеров.

Лицензия

MIT