WordPress.org, январь 2023: изменения в устройстве пользовательской документации
Начало:
1. Откуда начать изучение WordPress с точки зрения пользователя
2. WordPress: как устроена панель управления (dashboard)
3. Последовательность изучения статей пользовательской документации сайта «WordPress.org»
В визуальном дизайне веб-страниц
Изменения в визуальном дизайне веб-страниц раздела пользовательской документации сайта «WordPress.org» заметны на глаз. Вот иллюстрации (при щелчке мышью по иллюстрации она откроется в оригинальном размере):
На иллюстрациях выше слева показано то, как раздел пользовательской документации выглядел до изменений, справа - то, как этот раздел выглядит сейчас.
В URL-адресах (в постоянных ссылках)
URL-адрес тоже поменяли. Было раньше:
https://wordpress.org/support/
Стало теперь:
https://wordpress.org/documentation/
Соответственно, поменялись и URL-адреса статей, в них слово «support» было заменено словом «documentation». Со старых URL-адресов настроена переадресация на новые URL-адреса (это как раз тот редкий случай изменения постоянных ссылок на материалы сайта, о возможности которого я писал в посте про постоянные ссылки, «permalinks»).
Главное изменение: в структуре организации статей
Конечно, визуальные изменения в дизайне веб-страниц - это мелочь, которую можно было и не заметить. Такие изменения на популярных сайтах происходят постоянно; когда сайт активен, он живой, он живёт. Главное изменение, которое случилось - изменение в структуре организации статей.
Кстати, команда документации, поддерживающая в том числе пользовательскую документацию сайта, учла некоторые мои замечания, о которых я писал в отдельном посте (а также писал в сообщении о проблеме [issue] в отслеживателе проблем [issue tracker] команды документации на «Гитхабе»). Возможно, что учли именно мои замечания, а возможно, что указываемые мною проблемы были очевидны и для других людей. Что именно учли?
1. В частности, при изучении пользовательской документации по URL-ссылкам с домашней страницы пользовательской документации теперь практически не встречаются «дубликаты», то есть когда одна и та же статья попадает в несколько категорий. Документацию стало удобнее изучать.
2. Появились «разделы категорий», они видны на домашней странице пользовательской документации. URL-ссылки на страницы этих разделов категорий формируются по следующему принципу:
https://wordpress.org/documentation/название-раздела/
Сейчас есть четыре таких раздела:
https://wordpress.org/documentation/overview/
https://wordpress.org/documentation/technical-guides/
https://wordpress.org/documentation/support-guides/
https://wordpress.org/documentation/customization/
Каждый раздел содержит несколько категорий. Таким образом реализована дополнительная организация статей внутри больших категорий (разделов категорий), о необходимости которой я писал.
3. Частично реализована идея о карте всех статей на одной странице. Такой карты по-прежнему нет для всех статей пользовательской документации, но такие карты есть по отдельности для каждого раздела категорий. Их можно открыть по четырем приведенным выше URL-ссылкам. Но я самостоятельно составил нужную мне карту всех статей пользовательской документации сайта «WordPress.org» на «Гитхабе»:
https://github.com/ilyachalov/wp-org-docs-contents/blob/main/into-categories.md
Еще изменения в организации статей
Кроме тех идей, которые предлагал я, у команды документации, конечно, были свои идеи, которые они реализовали.
4. Например, авторы изменений продолжили реализовывать свою идею разделения пользовательской документации на часть для авторов контента (менее продвинутых в техническом плане) и часть для людей, обслуживающих сайты с технической точки зрения (разработчиков, администраторов сетей, администраторов баз данных и тому подобных). Неформально эти части называют «HelpHub» и «DevHub», в плане URL-ссылок это выглядит так:
«HelpHub»
https://wordpress.org/support/ (устаревший URL-адрес)
https://wordpress.org/documentation/
«DevHub»
https://developer.wordpress.org
Довольно большое количество статей, ранее входивших в «HelpHub», теперь вынесено в одну из скрытых категорий:
https://wordpress.org/documentation/category/devhub/
Эти статьи находятся в процессе переноса в состав статей «DevHub».
5. Полностью изменена категоризация статей. Количество категорий стало больше, у старых категорий изменены названия, URL-адреса старых категорий переадресуются на URL-адреса соответствующих новых категорий. Содержание категорий (состав статей) полностью изменено. Некоторые статьи перенесены в «DevHub», некоторые перенесены из одной категории в другую. В категории добавлено множество статей, которые существовали и ранее, но не находились ни в одной из ранее сущестововавших категорий (но были доступны по ссылкам из других статей).
Особенно много изменений в категоризации касается новых категорий со статьями про блочный редактор (он же «новый», он же «Gutenberg»). Там есть большое количество статей про разные виды блоков, а также про интерфейс блочного редактора и работу с частями этого интерфейса.
6. Теперь из каждой статьи видно, в какой категории и в каком разделе категорий она находится. Это можно увидеть вверху страницы статьи, под главным меню сайта.
Полезная ссылка
https://make.wordpress.org/docs/2023/01/24/new-look-new-site-new-helphub/
1. Откуда начать изучение WordPress с точки зрения пользователя
2. WordPress: как устроена панель управления (dashboard)
3. Последовательность изучения статей пользовательской документации сайта «WordPress.org»
В визуальном дизайне веб-страниц
Изменения в визуальном дизайне веб-страниц раздела пользовательской документации сайта «WordPress.org» заметны на глаз. Вот иллюстрации (при щелчке мышью по иллюстрации она откроется в оригинальном размере):
На иллюстрациях выше слева показано то, как раздел пользовательской документации выглядел до изменений, справа - то, как этот раздел выглядит сейчас.
В URL-адресах (в постоянных ссылках)
URL-адрес тоже поменяли. Было раньше:
https://wordpress.org/support/
Стало теперь:
https://wordpress.org/documentation/
Соответственно, поменялись и URL-адреса статей, в них слово «support» было заменено словом «documentation». Со старых URL-адресов настроена переадресация на новые URL-адреса (это как раз тот редкий случай изменения постоянных ссылок на материалы сайта, о возможности которого я писал в посте про постоянные ссылки, «permalinks»).
Главное изменение: в структуре организации статей
Конечно, визуальные изменения в дизайне веб-страниц - это мелочь, которую можно было и не заметить. Такие изменения на популярных сайтах происходят постоянно; когда сайт активен, он живой, он живёт. Главное изменение, которое случилось - изменение в структуре организации статей.
Кстати, команда документации, поддерживающая в том числе пользовательскую документацию сайта, учла некоторые мои замечания, о которых я писал в отдельном посте (а также писал в сообщении о проблеме [issue] в отслеживателе проблем [issue tracker] команды документации на «Гитхабе»). Возможно, что учли именно мои замечания, а возможно, что указываемые мною проблемы были очевидны и для других людей. Что именно учли?
1. В частности, при изучении пользовательской документации по URL-ссылкам с домашней страницы пользовательской документации теперь практически не встречаются «дубликаты», то есть когда одна и та же статья попадает в несколько категорий. Документацию стало удобнее изучать.
2. Появились «разделы категорий», они видны на домашней странице пользовательской документации. URL-ссылки на страницы этих разделов категорий формируются по следующему принципу:
https://wordpress.org/documentation/название-раздела/
Сейчас есть четыре таких раздела:
https://wordpress.org/documentation/overview/
https://wordpress.org/documentation/technical-guides/
https://wordpress.org/documentation/support-guides/
https://wordpress.org/documentation/customization/
Каждый раздел содержит несколько категорий. Таким образом реализована дополнительная организация статей внутри больших категорий (разделов категорий), о необходимости которой я писал.
3. Частично реализована идея о карте всех статей на одной странице. Такой карты по-прежнему нет для всех статей пользовательской документации, но такие карты есть по отдельности для каждого раздела категорий. Их можно открыть по четырем приведенным выше URL-ссылкам. Но я самостоятельно составил нужную мне карту всех статей пользовательской документации сайта «WordPress.org» на «Гитхабе»:
https://github.com/ilyachalov/wp-org-docs-contents/blob/main/into-categories.md
Еще изменения в организации статей
Кроме тех идей, которые предлагал я, у команды документации, конечно, были свои идеи, которые они реализовали.
4. Например, авторы изменений продолжили реализовывать свою идею разделения пользовательской документации на часть для авторов контента (менее продвинутых в техническом плане) и часть для людей, обслуживающих сайты с технической точки зрения (разработчиков, администраторов сетей, администраторов баз данных и тому подобных). Неформально эти части называют «HelpHub» и «DevHub», в плане URL-ссылок это выглядит так:
«HelpHub»
https://wordpress.org/support/ (устаревший URL-адрес)
https://wordpress.org/documentation/
«DevHub»
https://developer.wordpress.org
Довольно большое количество статей, ранее входивших в «HelpHub», теперь вынесено в одну из скрытых категорий:
https://wordpress.org/documentation/category/devhub/
Эти статьи находятся в процессе переноса в состав статей «DevHub».
5. Полностью изменена категоризация статей. Количество категорий стало больше, у старых категорий изменены названия, URL-адреса старых категорий переадресуются на URL-адреса соответствующих новых категорий. Содержание категорий (состав статей) полностью изменено. Некоторые статьи перенесены в «DevHub», некоторые перенесены из одной категории в другую. В категории добавлено множество статей, которые существовали и ранее, но не находились ни в одной из ранее сущестововавших категорий (но были доступны по ссылкам из других статей).
Особенно много изменений в категоризации касается новых категорий со статьями про блочный редактор (он же «новый», он же «Gutenberg»). Там есть большое количество статей про разные виды блоков, а также про интерфейс блочного редактора и работу с частями этого интерфейса.
6. Теперь из каждой статьи видно, в какой категории и в каком разделе категорий она находится. Это можно увидеть вверху страницы статьи, под главным меню сайта.
Полезная ссылка
https://make.wordpress.org/docs/2023/01/24/new-look-new-site-new-helphub/