Область документации и правила ASD-STE100
Область документации и правила ASD-STE100. Пользовательская инструкция Flowbay.
PA-240 · Редакция 1 · 16.11.2026
Область применения
Раздел описывает пользовательские операции модуля «Товары → Ассортимент» в Flowbay. Проверка названий и поведения выполнена по текущим исходным кодам интерфейса и сервиса товарного учёта 16.11.2026.
Документация включает создание, просмотр, изменение, дублирование, объединение, архивирование и выгрузку вариантов. Также описаны поля, медиа, черновики, остатки и типовые ошибки.
Складские документы, настройка интеграций и полная аналитика относятся к отдельным модулям. Здесь указаны точки перехода и влияние на товары.
Установленная версия интерфейса организации может обновляться отдельно. Если названия или функции отличаются, передайте адрес страницы в поддержку.
Применение ASD-STE100
ASD-STE100 Simplified Technical English — стандарт технического английского языка. Этот раздел написан на русском языке и использует адаптацию принципов STE. Он не заявляет формального соответствия английскому словарю стандарта.
Для русских инструкций действуют следующие редакционные правила:
- Используйте один термин для одного объекта.
- Пишите короткие предложения в активном залоге.
- Начинайте шаг с действия в повелительном наклонении.
- Указывайте одно основное действие в одном шаге.
- Ставьте условие до действия, к которому оно относится.
- Отделяйте описание системы от порядка действий.
- Указывайте исходные условия и проверяемый результат.
- Сообщайте о риске потери данных до соответствующего действия.
- Приводите точные названия кнопок и полей.
- Не описывайте недоступную команду как работающую.
Это редакционные правила Flowbay, основанные на принципах STE. Полный стандарт и его английский словарь доступны через официальный сайт.
Структура процедуры
| Часть | Содержание |
|---|---|
| Назначение | Одна задача пользователя. |
| Перед началом | Условия, доступ и исходные данные. |
| Порядок действий | Последовательность нумерованных шагов. |
| Результат | Признак успешного завершения. |
| Если операция не выполнена | Проверки и безопасный порядок повторения. |
| Связанные инструкции | Следующая задача или нужный справочник. |
Справочные статьи могут содержать таблицы вместо процедуры. Названия полей приводятся в кавычках и выделяются полужирным.
Обозначения и редакции
Код PA-… — постоянный идентификатор статьи. Он помогает сослаться на процедуру без совпадения названий.
Редакция 1 — первоначальное наполнение раздела. При изменении действий обновите редакцию и дату проверки статьи.
Проверка новой статьи
Перед публикацией редактор должен проверить доступность описанной команды, названия полей и последствия операции. Для действия с несколькими товарами нужно отдельно проверить частичный успех и повторное выполнение.
ИИ может подготовить текст. Проверка по действующему интерфейсу и правилам раздела остаётся частью публикации.