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

Здесь представлены темы для работы над пользовательской документацией.

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

Подробный список можно найти на https://github.com/joomla/documentation/issues. Там же можно найти обсуждения по теме и справочную информацию. Там же можно отметить, что вы работаете над конкретным материалом, чтобы избежать работы над одной темой сразу несколькими людьми.

В центре внимания: обзорные страницы

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

Ниже приведён список недостающих обзорных страниц. Чем больше материалов находится под этой обзорной страницей, тем сильнее потребность в хорошей обзорной странице.

В центре внимания: учебные материалы о создании сайта

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

Как устроены эти учебные материалы по созданию сайта и какие существующие материалы руководства пользователя можно использовать для этого, можно узнать в этой таблице (в процессе работы).

Подробнее можно узнать во всех подпунктах этого вопроса: ... todo...

См. меню слева на странице учебных материалов. Там можно увидеть, как может выглядеть учебный материал.

Об учебных материалах

Учебный материал почти никогда не бывает исчерпывающим. Он лишь показывает один из способов что-то сделать, а не все альтернативные возможности для этого.
Главная цель — показать некоторые концепции, которые вы хотите донести. Никаких длинных объяснений. Учебный материал — это обучение через действие.
Учебный материал предлагает последовательность шагов, которые читатель может повторить, приводящую к воспроизводимому результату. При этом путь важнее результата.
фиксированный порядок:
- Начните с обзора предварительных условий: какие учебные материалы нужно пройти перед этим.
- Затем краткое описание того, о чём этот учебный материал (краткое описание примера).
- Затем шаги, которым нужно следовать
- Завершите выводом: краткое изложение рассмотренных концепций.

Другие темы, над которыми можно поработать:

Настраиваемые поля.
Практические руководства с mod_articles.
Учебный материал: Добавление модуля на панель управления.
Переопределения шаблонов.
Полезные материалы журнала.

Настраиваемые поля

Необходимо:

учебный материал, объясняющий использование настраиваемых полей; сейчас: https://docs-core.sandbox.joomla.org/user-manual/fields/fields-fields-and-field-groups
Среди всех материалов, относящихся сейчас к разделу «поля», есть 4 общих материала (поля и группы полей, параметры полей, многоязычные сайты и переопределения шаблонов). Они находятся на одном уровне с 15 типами настраиваемых полей и одним материалом об особом настраиваемом поле: подформе. Можете ли вы предложить более удачную структуру вместо размещения всех этих материалов на одном уровне? Если нужен более глубокий уровень вложенности, не забудьте про обзорную страницу.
руководство о том, как повторять настраиваемые поля (с использованием подформы).
пример использования вложенных подформ в настраиваемых полях (новое с версии 5.2).
справочник (обзор) по всем настраиваемым полям + краткое описание.
учебный материал о переопределениях шаблонов. см. https://docs-core.sandbox.joomla.org/user-manual/fields/fields-adding-custom-fields-overrides

См. серию статей о настраиваемых полях от Marc Dechèvre в Magazine: