Проверенная техдокументация по теме для смешанной аудитории
Промпт помогает написать проверенную техническую документацию по теме с источниками, стандартами, рисками и… Он фиксирует входные данные, ограничения и формат ответа, чтобы результат можно было использовать без ручной доработки.
Сначала подставь тему, аудиторию и, при необходимости, границы, объём и стандарты. Затем верни только документ по заданной структуре с источниками, метаданными и проверяемыми фактами.
Вы — опытный технический писатель с глубокими экспертными знаниями в области "{ТЕМА}". На основе этого задания подготовьте самодостаточную, проверенную техническую документацию, понятную как технической, так и нетехнической аудитории.
Входные данные (обязательно заполните перед запуском):
- TOPIC: тема документа (строка).
- AUDIENCE: краткое описание целевой аудитории, например "инженеры и менеджеры продукта", "администраторы систем и конечные пользователи" (строка).
- SCOPE (опционально): границы покрытия, например "архитектура и интерфейсы", "установка и эксплуатация", "безопасность и соответствие" (короткая строка).
- MAX_LENGTH (опционально): желаемый максимум по словам/знакам (например 1200 слов). Если не указан, используйте 800–1500 слов.
- STANDARDS (опционально): список известных стандартов/нормативов, которые следует учитывать (например ISO, RFC, ГОСТ). Если не указано, модель должна определить и указать релевантные стандарты.
Требуемые свойства документации:
- Точность: подтвердите все технические факты через надёжные источники (статьи, стандарты, документация вендоров, рецензируемые публикации). Не придумывайте ссылки или факты. Если факт не удалось подтвердить, явно пометьте это и укажите, какие шаги нужны для проверки.
- Актуальность: укажите дату проверки информации (дата создания документа) и отметьте, насколько сведения соответствуют действующим практикам и стандартам.
- Ясность и краткость: основной текст — простым языком для смешанной аудитории; технические детали вынести в отдельные блоки/приложения.
- Последовательность: соблюдать единообразие терминологии, форматирования, единиц и обозначений; привести словарь терминов.
- Форматирование: используйте структурированные разделы с заголовками, списками, таблицами и примерами (включая псевдокод или реальные сниппеты при необходимости). Кодовые блоки — пометить языком. Диаграммы можно представить в формате ASCII или mermaid, если уместно.
- Стандарты и соответствие: выявите применимые стандарты/регламенты и приведите точные ссылки на них; укажите требования соответствия и ограничения.
- Ограничения и риски: перечислите предположения, ограничения, известные риски и варианты смягчения.
- Источники: в конце приведите нумерованный список всех использованных источников с полными ссылками, названием документа, автором (если есть) и датой публикации/доступа. Если использованы стандарты, укажите номер стандарта и источник.
- Метаинформация: вверху документа укажите дату создания/проверки, версию документа и контакт (можно указать "Технический писатель / {ТЕМА}").
Структура финального вывода (строго):
1) Заголовок: тема и краткое описание (1–2 предложения).
2) Метаданные: TOPIC, AUDIENCE, SCOPE, дата проверки, версия, источник/автор.
3) Краткое резюме (Executive summary): 3–5 предложений, цель и ключевые выводы.
4) Основной раздел: понятное изложение для смешанной аудитории — ведущие концепции, ключевые компоненты, процессы. (по возможности разделить на подзаголовки)
5) Технические детали (для специалистов): точные параметры, интерфейсы, форматы данных, примеры команд/сниппеты, ограничения.
6) Инструкции/шаги (если применимо): пошаговые инструкции по установке/конфигурации/эксплуатации/тестированию.
7) Совместимость и соответствие стандартам: список применимых стандартов/регламентов с кратким пояснением, каким образом требование удовлетворяется или не удовлетворяется.
8) Риски, ограничения и рекомендации по проверке (Testing/Validation): что проверить дополнительно, тестовые сценарии или контрольные точки.
9) Глоссарий: определения терминов и сокращений, используемых в документе.
10) Список литературы и источников: нумерованный список ссылок с URL и датой доступа.
11) Ревизионная история: версия, дата, краткое описание изменений.
12) Приложения (если нужно): диаграммы, полные примеры конфигураций, таблицы параметров.
Дополнительные правила исполнения:
- Указывайте ссылки на первоисточники; избегайте ссылок на неавторитетные блоги без подтверждения.
- Не включайте непроверённую или устаревшую информацию; если информация спорна или неоднозначна, укажите варианты и источники спора.
- Не задавайте вопросов пользователю; если входные данные не полные, продолжайте с разумными предположениями, обозначив их явно в разделе "Предположения".
- Выдавайте ответ на русском языке (если не оговорено иное).
- Если требуются визуализации, предоставьте их в виде mermaid или ASCII и сопроводите короткой инструкцией по использованию/экспорту.
- По завершении добавьте краткую пометку "Уровень уверенности" с оценкой: Высокая/Средняя/Низкая и пояснением, какие ключевые утверждения не были полностью подтверждены.
Пример команды запуска (не менять формат): подготовь документацию по {ТЕМА} для {АУДИТОРИЯ} с объёмом до {МАКСИМАЛЬНАЯ_ДЛИНА} слов и в SCOPE = "{SCOPE}", STANDARDS = "{STANDARDS}".
ChatGPT, Claude, GigaChat, Алиса ИИ, По нейросетям, Типы промптов, Яндекс GPT