На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Маутик
- Технический писатель:
- Свати Такер
- Название проекта:
- Просмотрите и обновите документацию конечного пользователя для Mautic.
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
Мои первые впечатления при просмотре существующей документации:
В настоящее время документация длинная, во многих местах избыточная, неполная и беспорядочная, что может затруднить пользователям поиск необходимой информации.
Будучи начинающим пользователем, я не мог понять, как различные элементы Mautic, такие как кампании, активы, сообщения, категории и т. д., сочетаются друг с другом для решения бизнес-задач. Я предлагаю создать концептуальную тему высокого уровня, описывающую каждый элемент Mautic в 2-3 строках. Эта тема, в свою очередь, может быть связана с различными подробными темами задач для каждого из этих элементов.
Руководство по участию можно расширить, включив в него дополнительную информацию, например, как открыть задачу, как предложить новый контент/идеи, сообщить об ошибках/проблемах/уязвимостях безопасности и т. д., предоставив ссылки на форумы, слабые каналы и репозитории git. Кроме того, руководство по стилю необходимо расширить, включив в него стандартные типографские соглашения, рекомендации по изображениям, таблицам и т. д.
Более того, в электронных письмах, кампаниях содержится немало неполной информации, а также старой/устаревшей информации, требующей обновления.
Область, в которой я хотел бы внести свой вклад:
Обсуждая каналы Slack, где пользователи напрямую взаимодействуют с сообществом Mautic, я понял, что кампании и электронные письма являются важнейшими элементами Mautic. Используя Mautibox версии 3, я протестировал документацию по кампаниям и обнаружил, что она нуждается в серьезной доработке. Вот некоторые проблемы, которые я обнаружил, и мое предложение по каждой из них:
- Пользователь Mautic может выбирать из множества действий, решений и условий при создании кампании. На многие действия и решения отсутствует документация, почти нет документации по условиям кампании. Нам необходимо определить и добавить недостающую информацию в документ конечного пользователя.
- Кампании могут быть простыми или очень сложными. Текущая документация не представляет особой ценности для пользователей, которые впервые создают кампании. Я предлагаю определить некоторые варианты использования (как простые, так и сложные) и создать примеры рабочих процессов (либо в форме пошаговых руководств, либо тем в руководстве для конечного пользователя, либо в пошаговых видеороликах), которые сможет использовать начинающий пользователь. обратитесь к ним, прежде чем приступить к созданию собственных кампаний.
- В этом разделе информация должна быть представлена более организованно и упорядоченно. Для повышения удобства использования необходимо следовать подходу, основанному на задачах и концепциях. В темах можно использовать таблицы для представления информации о действиях, решениях и условиях. Тема «Использование триггеров даты» кажется немного неуместной. Он может вкладываться в Условия.
Помимо кампаний, я также проверил документацию по электронной почте на соответствие пользовательскому интерфейсу. Вот над чем я предлагаю поработать:
- Динамический контент для электронных писем доступен для шаблонов электронных писем с пользовательским кодом (как для электронных писем с шаблонами, так и для электронных писем с сегментами), но в настоящее время для него нет документации. Добавьте подробную информацию о том, что делает динамический контент и как его настроить, а также несколько примеров.
- Добавьте отдельную тему для мониторинга электронной почты. Сюда может входить информация об использовании виджетов электронной почты, доступных на информационной панели, и о том, как их можно использовать для отслеживания показателей и действий, связанных с электронной почтой. Также переместите сюда информацию об отслеживании электронных писем.
- В документации не разъясняется, что ответы на контакты, управление возвратами, почтовая программа является владельцем — это глобальные настройки конфигурации, которые можно настроить в разделе «Настройки электронной почты». Все настройки электронной почты должны относиться к одной общей теме. Кроме того, многие другие настройки электронной почты, такие как правила частоты по умолчанию и настройки отказа от подписки, вообще не документированы. Укажите, какие настройки являются обязательными, а какие необязательными.
- Со страницы управления Bounce удалите всю информацию о веб-перехватчиках и поместите ее в отдельную тему для веб-перехватчиков. Затем мы можем предоставить ссылку на эту тему отсюда.
Дополнительно: - В теме Dashboard указана неполная информация о доступных виджетах. Эта информация важна и ее необходимо добавить, поскольку она помогает пользователям анализировать и контролировать свои ресурсы Mautic.
Необходимо просмотреть всю документацию, чтобы выявить пробелы. Нам необходимо обновить документ, чтобы сделать его более доступным для наших пользователей.
Как я ожидаю, что мои знания/опыт принесут пользу этому проекту?
Поработав за последний месяц над различными проблемами документации Mautic, включая добавление поддержки последней версии Mautic 3.0, я смог ознакомиться со структурой документации для конечных пользователей, а также выявить пробелы в документации. Я потратил время на изучение документации по другим инструментам автоматизации маркетинга и сравнение ее с документацией для конечных пользователей Mautic, чтобы понять, как мы можем заполнить эти пробелы в нашей документации. Мое знакомство с языком HTML, инструментами с открытым исходным кодом и процессами является дополнительным преимуществом. В настоящее время я прохожу курс исследования пользовательского опыта и могу применить эти принципы для создания документации, более ориентированной на пользователя. Кроме того, благодаря моему опыту в информационной архитектуре я смогу организовывать контент и предлагать идеи для согласования нашей документации с целями пользователей. Более того, у меня есть способность расширять свои знания в новых технических областях. Имея 10-летний опыт написания технических статей и мой предыдущий опыт GSOD по успешному завершению проекта для организации в совершенно новой для меня технической области, я уверен, что смогу отдать должное своему вкладу в документацию Mautic.