Промпт формирует прикладное руководство по документированию интерфейсов или взаимодействий между компонентами, включая шаблоны артефактов, пример контракта, чек-лист ревью и правила версионирования для интеграции.
В этом промпте 29 строк и 1618 символов
Подготовь практическое руководство для документирования {interfaces/interactions} между компонентами системы, чтобы обеспечить бесшовную {integration/collaboration} в ходе разработки.
Входные параметры:
- {position}
- выбор: {interfaces} или {interactions}
- выбор: {integration} или {collaboration}
- опционально: архитектурный стиль, ключевые технологии и требование к sync / async
Требования:
- Язык: русский.
- Стиль: практический, адресованный инженерам и владельцам требований.
- Объём: ориентир 800–1200 слов.
- Не задавай уточняющих вопросов.
Верни ответ строго по разделам:
1. Краткая цель и контекст, 1–3 предложения, от имени {position}.
2. Методы документирования, 6–10 пунктов. Для каждого укажи описание, когда применять, преимущества, ограничения, пример результата.
3. Шаблоны как plain text минимум для трёх артефактов:
- спецификация интерфейса / API;
- схема взаимодействия / последовательность;
- каталог интерфейсов / контрактов.
Каждый шаблон — не более 12 строк и минимально достаточен для заполнения.
4. Короткий заполненный пример: один интерфейс и соответствующая последовательность взаимодействия на 3–8 шагов.
5. Рекомендуемые нотации и инструменты, до 8 позиций, с кратким объяснением применимости.
6. Чек-лист ревью и приёмки интеграции, 8–12 пунктов.
7. Правила версионирования и управления изменениями, 4–6 пунктов.
8. Рекомендации по внедрению в процесс разработки, 4–6 шагов, включая размещение артефактов, ответственность и автоматизацию проверок в CI.
Не добавляй длинную теорию. Каждый раздел должен быть готов к немедленному использованию командой разработки и QA.
Промпт доступен бесплатно после авторизации.
Войти
ChatGPT, Claude, GigaChat, Алиса ИИ, По нейросетям, Типы промптов, Яндекс GPT