Переструктурирование документации для повышения ясности

:white_check_mark: Обновление (4 июня 2024 г.): Начальная работа по реструктуризации тем документации завершена, новые категории уже доступны, а новые индексы показывают, что в них содержится. Вы можете ознакомиться с ними здесь: Documentation - Discourse Meta — если заметите какие-либо неточности, пожалуйста, напишите об этом ниже!

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

Чего ожидать

:label: Новые категории

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

:eyes: Временные визуальные изменения

В процессе реструктуризации вы можете заметить, что некоторые разделы нашей документации выглядят немного не на месте или неорганизованно. Не волнуйтесь! Это временно, пока мы работаем над завершением новой структуры.

:white_check_mark: Комплексные обновления

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

Как вы можете помочь

Ваша обратная связь, как всегда, бесценна для нас. Если вы обнаружите какие-либо проблемы или у вас есть предложения по дальнейшему улучшению нашей документации, пожалуйста, не стесняйтесь делиться своими мыслями в канале Contribute > Site feedback или в виде поста в этой теме.

Спасибо, что остаетесь с нами, пока мы вносим эти изменения!

14 лайков

Темы, касающиеся модерации, например Discourse Moderation Guide, относятся к категории Documentation > Site Management. Возможно, это стоит добавить в описание, так как в роли модератора я не стал бы искать подобные темы в категории для «владельцев и администраторов сайта».

3 лайка

Я внес небольшую правку в текст раздела «О нас», чтобы указать, что он также полезен для модераторов.

@JammyDodger и/или @hugh, возможно, выскажут дополнительные соображения, когда увидят это позже.

2 лайка

Я внёс небольшое дополнение:

4 лайка

Спасибо, что обратили на это внимание, @Moin!

@JammyDodger, ваше обновление выглядит хорошо.

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

Вы можете ознакомиться с ними здесь: Documentation - Discourse Meta — если заметите что-то неверное, пожалуйста, напишите об этом ниже!

1 лайк

Вы планируете добавить новые категории в плагин документации?

1 лайк

Мы колеблемся, стоит ли пробовать жизнь без плагина docs или нет. :slight_smile: Пока что я добавил новые категории в смесь. :+1:

3 лайка

Пост был объединен с существующей темой: Улучшенная навигация по документации с новой боковой панелью

Подскажите, пожалуйста, как формируется текст ссылок на темы в боковой панели при нахождении в подкатегории? С помощью ИИ?

1 лайк

У каждой подкатегории есть индексная тема, например: Using Discourse Index (ссылки на них размещены в описании в заголовке каждой подкатегории).

Боковая панель использует сокращённые заголовки оттуда, чтобы применять их вместо полных заголовков статей.

3 лайка