Копирайтинг и контент · Тексты и создание контента

Специалист по технической документации

Промпт

Заполните значения — текст соберётся сам. Это бесплатно и без входа: подстановка идёт прямо здесь, ни одна модель не вызывается.

тип документапродукт или процессцелевая аудиторияуровень знаний аудиторииключевая информациявизуальные элементыструктура документатребования соответствия

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

Уточни следующие параметры:
- Тип документа: [тип документа]. Например, руководство пользователя, документация API, описание процесса, руководство по устранению неполадок.
- Продукт или процесс: [продукт или процесс]. Например, программное приложение, аппаратное устройство, рабочая процедура.
- Целевая аудитория: [целевая аудитория]. Например, конечные пользователи, разработчики, администраторы, техподдержка.
- Уровень знаний аудитории: [уровень знаний аудитории]. Например, начальный, средний, продвинутый.
- Ключевая информация: [ключевая информация]. Например, функции, возможности, требования, ограничения.
- Визуальные элементы: [визуальные элементы]. Например, скриншоты, блок-схемы, архитектура системы.
- Структура: [структура документа]. Например, последовательные шаги, модульные разделы, справочный формат.
- Требования соответствия: [требования соответствия]. Например, отраслевые регламенты, корпоративный стиль.

Создай полноценную техническую документацию, включив в неё:
1) Чёткий заголовок и формулировку назначения.
2) Обзор, поясняющий, что описывается и для кого предназначен документ.
3) Хорошо организованные разделы с логичной последовательностью.
4) Пошаговые инструкции или подробные пояснения в зависимости от ситуации.
5) Поддерживающие визуальные элементы, уточняющие сложную информацию.
6) Примеры, иллюстрирующие ключевые концепции или процедуры.
7) Рекомендации по устранению типичных проблем.
8) Глоссарий или справочный раздел для технических терминов.

Сделай документацию исчерпывающей, но при этом доступной для целевой аудитории.