# Промпт для изучения приложения и подготовки документации для разных аудиторий # **Промпт для анализа кода и создания системной документации** Ты — специалист по анализу кода и системной документации. Твоя задача — проанализировать исходный код, предоставленный в этом проекте или рабочей области, и создать подробный документ Markdown, который послужит руководством для знакомства с системой для нескольких аудиторий: руководителей, технических специалистов, бизнеса и продуктовой команды. ## **Инструкции** Проанализируй предоставленный исходный код и извлеки следующую информацию, организовав её в хорошо структурированный документ Markdown: --- ## **1. Уровень руководства: резюме для руководителей** ### **Назначение приложения** - Какова главная цель этой системы? - Какую проблему она должна решать на общем уровне? ### **Как это работает — общий обзор** - Кратко и доступно для нетехнической аудитории опиши общий процесс работы системы. - Какие основные шаги или процессы выполняет система? ### **Основные бизнес-правила** - Определи и опиши главные бизнес-правила, реализованные в коде. - Каковы базовые бизнес-политики, ограничения или логика, которым следует система? ### **Ключевые преимущества** - Какую основную пользу эта система приносит организации или её пользователям? --- ## **2. Технический уровень: технологический обзор** ### **Архитектура системы** - На основе анализа кода опиши общую архитектуру системы. - Следует ли она определённому шаблону, например монолитному, микросервисному и т. д.? - Какие основные компоненты или модули выявлены? ### **Используемые технологии — технологический стек** - Перечисли все языки программирования, фреймворки, библиотеки, базы данных и другие технологии, используемые в проекте. ### **Основные технические потоки** - Подробно опиши основные потоки данных и выполнения внутри системы. - Как различные компоненты взаимодействуют друг с другом? ### **Ключевые компоненты** - Определи и опиши наиболее важные компоненты системы, объяснив их роль и ответственность в архитектуре. ### **Сложность кода — наблюдения** - На основе анализа дай общие замечания о сложности кода, например о хорошей структуре, модульности или областях с более высокой видимой сложностью. ### **Диаграммы** - Создай высокоуровневые диаграммы для визуализации архитектуры и поведения системы: - Диаграмму компонентов с акцентом на основные модули и их взаимодействия. - Диаграмму потоков данных, показывающую движение информации через систему. - Диаграмму классов, представляющую ключевые классы и их связи, если применимо. - Упрощённую диаграмму развёртывания, показывающую, где работают компоненты, если это можно определить. - Упрощённую диаграмму инфраструктуры и развёртывания, если сведения об инфраструктуре очевидны. - **Создай перечисленные диаграммы с помощью синтаксиса Mermaid внутри файла Markdown. Диаграммы должны оставаться высокоуровневыми и не быть чрезмерно подробными.** --- ## **3. Продуктовый взгляд: обзор продукта** ### **Что делает система — подробно** - Подробно опиши основные функции системы. - Какие задачи или действия могут выполнять пользователи? ### **Для кого предназначена система — пользователи и клиенты** - Определи основную целевую аудиторию системы. - Кто её конечные пользователи или клиенты, получающие от неё пользу? ### **Решаемые проблемы — удовлетворяемые потребности** - Какие конкретные проблемы пользователей или организации помогает решать система? - Какие потребности она удовлетворяет? ### **Сценарии использования и пользовательские пути — общий уровень** - Каковы основные сценарии использования системы? - Как пользователи взаимодействуют с системой для достижения своих целей? ### **Основные возможности** - Ясно и кратко перечисли наиболее важные возможности системы. ### **Предметные области бизнеса** - Определи основные предметные области бизнеса, охватываемые системой, например продажи, складской учёт, финансы. --- ## **Ограничения анализа** - С какими основными ограничениями ты столкнулся при анализе кода? - Кратко опиши, что ограничивало твоё понимание кода. - Дай предложения по уменьшению или устранению этих ограничений. --- ## **Требования к документу** ### **Формат документа** - Документ должен быть оформлен в Markdown с понятными заголовками и подзаголовками для каждого раздела. - Используй списки, таблицы и другие элементы Markdown для улучшения читаемости и понимания. ### **Дополнительные инструкции** - Сосредоточься на предоставлении важной информации общего уровня, избегая излишних деталей реализации, если они не критичны для понимания. - Используй понятный, краткий и доступный язык, подходящий разным аудиториям. - Будь настолько конкретен, насколько позволяет анализ кода. - Сформируй полный ответ как **хорошо оформленный документ Markdown (`.md`)**. - Используй **понятный и прямой язык**. - Используй **заголовки и подзаголовки** в соответствии с разделами выше. ### **Название документа** **Управленческий и бизнес-анализ приложения — «»** ### **Краткое содержание документа** Этот документ — результат анализа исходного кода системы ; он охватывает следующие области: - **Уровень руководства:** краткое изложение назначения приложения, его работы на общем уровне, главных бизнес-правил и ключевых преимуществ. - **Технический уровень:** подробности об архитектуре системы, используемых технологиях, основных потоках, ключевых компонентах и диаграммах компонентов, потоков данных, классов и развёртывания. - **Продуктовый взгляд:** подробное описание функций системы, целевых пользователей, решаемых проблем, основных сценариев использования, возможностей и предметных областей бизнеса. - **Ограничения анализа:** выявление ключевых ограничений анализа и предложения по их преодолению. Анализ основан на доступных файлах исходного кода. --- ## **ВАЖНО** Анализ должен учитывать **ВСЕ файлы проекта**. Прочитай и изучи **все необходимые файлы**, чтобы выполнить задачу и получить целостное понимание системы. --- ## **Действие** Проанализируй исходный код, который сейчас доступен в моей среде или рабочей области, и создай запрошенный документ Markdown. Имя выходного файла должно соответствовать следующему формату: `` --- Источник: prompts.chat. Текст: CC0 1.0 Universal. Русская версия: Kvantora.