Эксперт по UML с использованием PlantUML для генерации диаграмм

Содержание

Кому нужен этот промт и как он работает?
Готовый к использованию промт
Как использовать промт и на что обратить внимание
Примеры использования
Пример ответа нейросети
Итоги: зачем использовать этот промт?

Кому нужен этот промт и как он работает?

Этот промт предназначен для разработчиков, архитекторов программных систем и аналитиков, которым требуется быстро и точно создавать UML-диаграммы с помощью PlantUML. Использование этого промта помогает автоматизировать процесс генерации кода диаграмм, упрощая визуализацию структуры, поведения и взаимодействий компонентов в проекте.

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

Работает промт следующим образом: пользователь вводит описание необходимой диаграммы, указывая ключевые детали и особенности. Затем нейросеть анализирует ввод, предлагает подходящий тип диаграммы, формирует корректный код PlantUML с учетом заданных параметров и особенностей синтаксиса, после чего возвращает его для дальнейшей генерации графического представления на платформе PlantUML.

Готовый к использованию промт

Вы эксперт по UML-диаграммам с глубокими знаниями и опытом использования Unified Modeling Language для проектирования и разработки программных систем. Вы хорошо знакомы с графическими символами UML и их значениями, умеете эффективно описывать структуру, поведение и взаимодействия компонентов программных систем с помощью UML-диаграмм.

Я, как разработчик, прошу вас создавать разметки на PlantUML для генерации диаграмм по адресу http://www.plantuml.com. Руководство находится здесь: https://plantuml.com/en/guide

Требования:

1. Соблюдайте достаточные интервалы в диаграммах для удобочитаемости.

2. Ждите моих описаний диаграмм перед началом работы.

3. Согласно моим вводным, указывайте возможные типы диаграмм.

4. Перед генерацией кода анализируйте данные, при необходимости дополняйте их, указывая другие применимые типы диаграмм.

5. В теле PlantUML используйте заданный язык контента {{Content_Language}}, а в ответах — {{Reply_Language}}.

6. Строго соблюдайте синтаксис PlantUML, избегайте ошибок.

7. При написании кода придерживайтесь следующих характеристик: {{Feature1}}, {{Feature2}}, {{Feature3}}, {{Feature4}}.

Для улучшения качества кода и цветовых схем можно ориентироваться на подготовленные примеры {{example}}.

Мой ввод: {{User_Input}}

Ваша задача — проанализировать контекст моего ввода, высказать понимание и мнение, указать тип диаграммы, затем предоставить код PlantUML. Если появятся лучшие идеи, продолжайте предложить их вместе с кодом. По окончании — давайте подробное объяснение созданного кода.

Если я недоволен результатом, запросите у меня уточнения и понимание замечаний, предложите новое решение, объясняйте изменения и вежливо спрашивайте, удовлетворены ли требованиями. При необходимости повторяйте процесс с более смелыми модификациями, даже если они противоречат прежним требованиям.

Как использовать промт и на что обратить внимание

Перед началом работы с промтом подготовьте четкое описание диаграммы, которое вы хотите получить. Чем подробнее будет ваш ввод, тем точнее и полезнее окажется результат.

Обратите внимание на следующие рекомендации:

Вводите информацию аккуратно, избегайте двусмысленностей.
Обозначайте предпочтительный язык для текста диаграммы (например, русский, английский) через параметры {{Content_Language}} и {{Reply_Language}}.
Проверяйте синтаксис сгенерированного кода перед использованием, хотя промт и нацелен на создание безошибочного кода.
Используйте предоставленные примеры {{example}} для ориентирования по стилю и цветовой схеме.
В случае несоответствия результата объясняйте, какие именно детали нужно улучшить или изменить — промт предполагает интерактивную корректировку с пользователем.

Возможные ограничения: при слишком обобщенных или неполных вводных данные могут быть интерпретированы не однозначно, что скажется на точности диаграммы. Также промт не генерирует изображения напрямую — только код PlantUML.

Примеры использования

Пример 1. Создание диаграммы классов для системы интернет-магазина.

1	Мой ввод: Опишите классы и их отношения для системы интернет-магазина, включающей пользователей, товары и заказы.

Этот пример помогает быстро получить структуру классов для дальнейшей реализации проекта.

Пример 2. Генерация диаграммы последовательностей для сценария регистрации пользователя.

1	Мой ввод: Опишите последовательность действий между пользователем, сервером и базой данных при регистрации нового пользователя.

Полезно для документирования бизнес-процессов и разработки API.

Пример ответа нейросети

После получения ввода «Создайте диаграмму классов для интернет-магазина с пользователями, товарами и заказами» нейросеть может ответить следующим образом:

✅ Анализ: Для описания структуры системы интернет-магазина оптимально использовать диаграмму классов, включающую основные сущности и отношения между ними. Также возможна диаграмма компонентов для представления модулей. Ниже код PlantUML для диаграммы классов.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

@startuml
class User {
  +id: int
  +name: string
  +email: string
}
class Product {
  +id: int
  +name: string
  +price: float
}
class Order {
  +id: int
  +date: Date
}
User "1" -- "0..*" Order : places
Order "1" -- "1..*" Product : contains
@enduml

Описание: Диаграмма показывает отношения между пользователем, заказами и товарами. Пользователь может делать несколько заказов, каждый заказ содержит один или несколько товаров.

Примечание: результат приблизительный и может отличаться.

Итоги: зачем использовать этот промт?

Использование этого промта позволяет разработчикам и архитекторам существенно экономить время на создании UML-диаграмм. Он обеспечивает точность, понятность и адаптацию к нуждам проекта, помогая быстро формировать визуальные модели систем и улучшать командное взаимодействие.