Как работать с документацией

Цветовая схема документа:

Синим помечены основные и дополнительные пояснения, либо не очевидные особенности описываемой в документе функции.

Зеленым помечены комментарии составителя дающие отсылку на смежные вопросы, поясняющие, или приводящие пример использования описываемого в документе функционала.

Оранжевым выделены замечания на которые ОБЯЗАТЕЛЬНО следует обратить внимание.

Красным выделяются моменты которые могут привести к необратимым последствиям, а так же действия которые следует предпринимать с полным понимаем происходящего и с особой осторожность.

В виде цитат даются определения, а также отсылки к дополнительному функционалу.
☞ 🔐Админ | 🧩Расширения | 📂Папка

Форматы текста:

Команды и макросы выделяются инлайн шрифтом кода: /команда, %макрос%.

Символы:

❖ - Символ заголовка
● - Вариант обозначения элемента списка.
«» - Кавычками "Елочка" обозначены названия функций.
☞- Символом указательного пальца обозначена начальная последовательность нажатий.
 • - Точкой обозначаются необходимые действия.
• • • - Разделитель
📆 - Функции с периодической оплатой.

Например:
• Перейдите...
☞ Шаг 1 > Шаг 2...
• Выберите...
• Нажмите...

Структура справочных материалов:

Раздел для новичков - Структура проекта и последовательность первоначальных действий.

Основные функции - Основные возможности доступные изначально в виде списка частых вопросов.

Помощь - Материалы помощи по меню бота, описывающие назначение и принципы работы кнопок в меню конструктора.

Руководства - Полное и максимально подробное описание отдельных функции.

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

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

Глоссарий - Алфавитный указатель наиболее употребимых терминов используемых в проекте конструктора, а также, описание общих понятий необходимых для работы с ним, либо встречающихся в руководствах.

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