User Documentation Структура
Текущие пять руководств изначально были опубликованы в виде материалов в Joomla Community Magazine, написаны Брайаном Тиманом и предоставлены им для этой документации.
Мы всё ещё работаем над структурой меню, чтобы разместить руководства, учебные материалы, пояснения и т.д. таким образом, чтобы их можно было динамически фильтровать и упорядочивать. Но пока мы просто публикуем эти руководства в случайном порядке.
О руководствах
Из https://diataxis.fr/how-to-guides/:
Руководства — это указания, которые направляют читателя через проблему или к результату. Руководства ориентированы на цель.
Руководство помогает пользователю сделать что-то правильно и безопасно; оно направляет действие пользователя.
Оно связано с работой — переходом от одной стороны реальной проблемной области к другой.
Примерами могут служить: как откалибровать радарную решётку; как использовать фикстуры в pytest; как настроить политики повторного подключения. С другой стороны, как создать веб-приложение — это не то, поскольку это не решает конкретную цель или проблему, это чрезвычайно открытая сфера навыков.
Руководства важны не только потому, что пользователям нужно уметь выполнять действия: список руководств в вашей документации помогает сформировать представление о том, что ваш продукт действительно может делать. Богатый список руководств — это обнадёживающий намёк на возможности продукта.