проект WordPress

На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.

Краткое описание проекта

Организация с открытым исходным кодом:
WordPress
Технический писатель:
Дмивелли
Название проекта:
Улучшение видимости статей в документации WordPress HelpHub
Длина проекта:
Стандартная продолжительность (3 месяца)

Описание Проекта

Управляющее резюме

Популярность WordPress растет с каждой минутой. По состоянию на начало июля 2020 года WordPress 5.4 (последняя версия, выпущенная 21 марта 2020 года) была загружена почти 51 миллион раз. Наиболее часто используемым языком является английский (71%), за ним следуют испанский (4,7) и индонезийский (2,4).

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

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

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

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

  1. Решите и установите стиль названий категорий.
  2. Оцените названия категорий и убедитесь, что они правильно соответствуют темам (при необходимости предложите обновления).
  3. Просмотрите статьи и убедитесь, что категоризации верны.
  4. Определите подкатегории для каждой статьи
  5. Убедитесь, что никакие результаты поиска не направляют пользователей на форумы поддержки.
  6. Отметьте повторяющиеся или устаревшие темы для удаления.

Сообщество WordPress проделало замечательную работу и поделилось достижениями за последние 17 лет. Обновление категоризации и обеспечение точности пользовательского пути будет продолжать способствовать росту, успеху и лояльности пользователей, которые создают почти 70 миллионов новых сообщений и 77 миллионов новых комментариев каждый месяц.

Введение

Автор Джозеф Кэмпбелл ввёл термин «Путешествие героя». В художественной литературе это относится к структурной концепции, в которой главный герой путешествует по миру, сталкивается с трудностями и преодолевает их и возвращается преображенным.

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

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

Я поговорил с консультантом WordPress и UX-дизайнером Эстелой Руэда, которая рассказала немного истории. В настоящее время некоторые заголовки некорректно описывают содержание статьи. Категории используются в качестве тегов, и поскольку они были созданы 15 лет назад, некоторые из них уже устарели. Маркировка непоследовательна. Это создает препятствия для пользователей, ищущих ответы.

Текущее состояние

Поддержка WordPress разделена на девять основных категорий (Начало работы, Установка WordPress, Базовое использование, Базовое администрирование, Настройка, Обслуживание, Безопасность, Расширенные темы, Устранение неполадок). Каждая категория содержит несколько подкатегорий или подтем, которые ведут к статьям, которые можно добавить на каждой целевой странице.

Преимущество наличия энтузиастов и активных участников WordPress заключается в том, что доступно множество тем. Однако, учитывая множество голосов и точек зрения, теги и категории несовместимы.

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

Плановый анализ

Основная цель — просмотреть и реклассифицировать статьи для улучшения поиска. Я предлагаю следующие шаги:

  1. Работайте с наставником Эстелой Руэдой, чтобы укрепить процесс.

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

  2. Решите и установите стиль названий категорий.

    • Я предлагаю единую, последовательную структуру категорий в настоящем времени вместо формы герундия (Установка или установка), поскольку форма герундия (-ing) может создать трудности для пользователей английского как второго языка (ESL) и - ing не добавляет ценности пользователю
    • Некоторые категории представляют собой темы, состоящие из одного или двух слов (например, «Обслуживание», «Безопасность», «Базовое администрирование»), а некоторые представляют собой фразы с деепричастием («Начало работы с WordPress», «Настройка») — имеет смысл обсудить обеспечение единообразия структуры.
    • Я изучаю, как другие организации настраивают свою онлайн-справку, и обсужу это со своим наставником, чтобы узнать, что может быть полезно.

  3. Оценивать названия категорий (и предлагать обновления)

    • Они должны быть узнаваемы с точки зрения целевой аудитории WordPress и соответствовать ее текущим потребностям.
    • Убедитесь, что они согласованы и соответствуют стандартам Руководства по стилю WordPress.
    • Убедитесь, что заголовки передают/объясняют намерение
    • Заголовки должны пояснять все необходимые предварительные действия или состояния пользователя/устройства.

  4. Обзор статей/тем

    • Точно ли темы соответствуют потребностям пользователей целевой аудитории WordPress?
    • Задают ли темы правильный контекст или они являются частью более широкой последовательности?
    • Различают ли этапы различных участников задачи (пользователя, систему/устройство, кто что делает)?
    • Четко ли различаются актеры?
    • Разбивают ли эти шаги сложные процессы на действенные части?

  5. Определите и пометьте подкатегории

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

  6. Убедитесь, что никакие результаты поиска не пересылают пользователей на форумы поддержки.

  7. Отметьте повторяющиеся или устаревшие темы для удаления; эта криминалистическая работа поможет информировать и оптимизировать работу пользователей

График

До 16 августа 2020 г.

  • Продолжить просмотр документации WordPress
  • Познакомьтесь поближе со стилем документации WordPress.
  • Изучите лучшие практики взаимодействия клиентов с темами помощи.

17 августа – 13 сентября

  • Познакомьтесь и поработайте с Эстелой и сообществом WordPress.
  • Сотрудничайте с Эстелой, чтобы уточнить этапы проекта и предложить этапы его завершения.
  • Создайте график, включающий вехи и еженедельные задачи.
  • Установите периодичность проверки статуса с помощью Estela (чтобы своевременно устранять любые блокирующие действия).

14 сентября – 30 ноября

  • Запуск проекта и работа по развитию с Эстелой/менторами

2-5 декабря

  • Отправить окончательный отчет о рабочем продукте

3-10 декабря

  • Отправьте оценку успеха проекта и опыт работы с наставниками и командой WordPress.

Заключение

WordPress — самая популярная система управления контентом (CMS). По данным W3techs, WordPress является CMS, которую выбирают 37,7% всех веб-сайтов, что дает WordPress 63,6% доли рынка CMS.

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

Принимая во внимание путь пользователя и вопросы, которые определяют возможные пути пользователя, WordPress может модернизировать категории справки и теги, чтобы эффективно отвечать на вопросы и устранять проблемы. Таким образом, WordPress будет продолжать привлекать довольных клиентов на долгие годы.