На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Творческое сообщество
- Технический писатель:
- ДжекиБиня
- Название проекта:
- Руководство по использованию базовой темы WordPress
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
На этапе подачи заявки техническим писателем на GSOD-2020 я несколько раз общался с Хьюго Соларом, который является наставником проекта документации базовой темы WordPress Creative Commons.
При первом контакте с ним я обратился за помощью в понимании целей создания руководства по использованию базовой темы WordPress. Он мне очень помог и быстро вовлек меня в проект. Все последующие взаимодействия, которые у нас были после этого, были посвящены уточнению целей документации базовой темы CC WordPress.
Когда я достиг определенного этапа, я почувствовал, что понял требования и цели проекта, и затем приступил к созданию чернового предложения для Руководства по использованию базовой темы CC WordPress.
Предложение было создано с использованием официального шаблона Creative Commons для заявок на стажировку. Он предоставляет информацию о кратком описании проекта, предлагаемой структуре проекта и макете документации по новой базовой теме WordPress, а также информацию о сроках и результатах этапа создания документа.
Затем компания Hugo Solar рассмотрела мой черновой вариант предложения и дала мне обратную связь, чтобы внести улучшения. На протяжении всего процесса он всегда был готов ответить на вопросы о проекте.
Я реализовал предоставленные отзывы, и мое окончательное предложение по созданию документации по значкам D&I доступно по ссылке ниже в виде документа Google.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
В качестве альтернативы, краткое изложение моего предложения находится ниже:
Creative Commons — Руководство по использованию базовой темы WordPress. Предложение подготовлено Жаклин Бинья, 28 июня 2020 г.
Краткое описание проекта Конечная цель этого проекта — создание богатой, интуитивно понятной, увлекательной и красиво представленной документации для сообщества по базовой теме Creative Commons WordPress.
План проекта Проблема В настоящее время базовая тема Creative Commons WordPress не имеет документации, что препятствует эффективному использованию темы в сообществе. Моя цель — создать полное руководство по использованию темы, а также реализовать абстракции в текущей кодовой базе темы WP Base, чтобы упростить использование темы.
Решение Создавайте футуристические документы, используя современные среды, такие как Gatsby. У Gatsby есть стартеры, которые мы можем использовать для загрузки новой документации по базовой теме WordPress. Примером стартового продукта является gatsby-gitbook-starter, который сразу же поставляется с поддержкой поисковой оптимизации (SEO), уценки и Algolia (инструмент, используемый для интеграции поиска на статических сайтах). В дополнение к этому любой сайт, созданный в стиле Gatsby, можно легко оптимизировать для интеграции интернационализации и доступности. При создании документации я стремлюсь сделать ее максимально интуитивно понятной путем: - написания документации в простой для понимания форме и старания избежать двусмысленности и использования чрезмерно сложного технического жаргона. - путем включения в документацию графических иллюстраций и мультимедийных материалов для использования в качестве наглядных пособий в обучении. - использование примеров, демонстрирующих, как выполнять общие задачи, например, настройку.
Абстракции, которые я надеюсь реализовать, будут включать в себя обеспечение того, чтобы большая часть основных функций базовой темы WP, таких как, например, хуки, могла использоваться пользователями из панели администратора WordPress. В дополнение к этому, я хотел бы создать стартовую дочернюю тему для базовой темы WP в отдельном репозитории. Наличие стартовой дочерней темы обеспечит более плавный и быстрый процесс адаптации для новых пользователей. Как только документация будет завершена и одобрена, она будет опубликована и размещена в Интернете.
Предлагаемая структура руководства по использованию базовой темы CC WordPress. Предлагаемая документация будет разделена на различные разделы, перечисленные ниже. Пункты подсписка в каждом предложенном разделе затем дают более подробную информацию о фактическом содержании, которое можно найти в соответствующих разделах.
Раздел «Обзор» — изложите определение, цели и особенности базовой темы WordPress Creative Commons (CC). * Определение: кратко опишите базовую тему CC WP. * Намерения: изложите цели/намерения базовой темы CC WP. * Возможности: изложите особенности базовой темы CC WP.
Раздел «Начало работы» — Требования * Опишите требования для установки базовой темы CC WordPress, т. е. — версия WordPress — версия PHP — Composer и т. д. — Руководство по установке * Опишите, как пользователи могут использовать zip для установки темы CC WordPress * Опишите, как пользователи могут начать работу с клонирование базовой темы WP с GitHub. * Опишите, как пользователи могут устанавливать зависимости в проекте. * Объясните, как пользователи могут настраивать зависимости Queulat. * Объясните, как пользователи могут активировать тему в своей локальной среде разработки WordPress.
Руководство по использованию - Обзор * Объясните термин «дочерняя тема» * Укажите преимущества использования дочерней темы. * Сообщите пользователям, что рекомендуемый способ редактирования темы WP Base — через дочернюю тему. * Подчеркните тот факт, что базовая тема WP должна быть установлена и активирована, прежде чем пользователи смогут создать дочернюю тему.
Использование дочерней темы. Объясните, как пользователи могут создать дочернюю тему базовой темы WP с помощью стартера. Используйте видео, чтобы объяснить, как пользователи могут создать дочернюю тему с самого начала.
Настройка В подразделах, перечисленных ниже, мы описываем, как пользователи могут использовать WordPress Customizer и панель администратора WordPress для выполнения настроек. Мы также будем использовать графические иллюстрации, чтобы сделать наши описания более интуитивно понятными. - Настройте описание сайта или слоган. - Пользовательские навигационные меню - Настройка CSS - Добавление страниц - Добавление сообщений - Виджеты - Добавление и удаление виджетов из панели администратора WordPress - Добавление виджетов с помощью настройщика с предварительным просмотром в реальном времени
Раздел «Расширенные настройки» — Раздел «Настройка CSS» * Опишите компоненты, составляющие стиль темы: — Словарь CC — Bulma — Sass * Объясните, как Sass настроен в проекте. Объяснение должно включать информацию о: (i) Расположение файлов sass в структуре проекта (ii) Скриптах npm, которые можно использовать для сборки и просмотра sass. * Объясните, как пользователи могут затем настраивать стили sass в дочерней теме, т.е. путем установки определенных зависимостей npm. * Объясните, как класс компонента (class-comComponent.php) используется для настройки стилей конкретных компонентов.
- Раздел крючков
Обзор
- Объясните термин «крючки»
- Объясните, почему пользователям необходимо использовать хуки.
- Опишите типы имеющихся крючков.
Использование действий
- Перечислите действия, доступные в теме WP Base, и их расположение.
- Объясните, как можно реализовать эти действия.
*Использование фильтров. Перечислите фильтры, доступные в теме, и объясните, как их можно реализовать.
Раздел «Обновление темы». Объясните, как пользователи могут обновить тему.
Раздел лицензирования * Объясните лицензирование проекта и его значение для людей, которые могут захотеть использовать базовую тему CC WP в своих личных проектах.
Раздел «Вклад» * Добавьте подробное руководство для участников * Изложите Кодекс поведения * Сообщество: предоставьте информацию о каналах сообщества Creative Commons, о том, как участники могут участвовать и т. д.