На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Колибри
- Технический писатель:
- Даниэль В.
- Название проекта:
- Рабочие процессы с контентом Колибри
- Длина проекта:
- Длительный ход (5 месяцев)
Описание Проекта
Приведенное ниже предложение было создано в результате проведения исследования и общения с наставниками Колибри. Мой разговор с наставниками помог мне развить личности пользователей, о которых я расскажу ниже. Кроме того, мои обсуждения помогли мне прийти к идее относительно репозитория/целевой страницы учебных пособий, чтобы у пользователей был выбор, какое учебное пособие они хотят просмотреть в соответствии со своими потребностями.
Обзор
Это предложение представляет собой решение для управления различными действиями пользователя, которые он может предпринять, импортируя контент со своего компьютера в Kolibri Studio, а затем из Kolibri Studio в Kolibri. Предлагаю создать центральный репозиторий обучающих материалов. Пользователь получит доступ к этим руководствам через целевую страницу. На целевой странице будет представлена таблица со ссылками на каждое руководство по рабочему процессу и указан тип пользователя, которому это руководство может быть полезно. Таким образом, учебные пособия будут более персонализированы в соответствии с потребностями и возможностями пользователя. Рабочий процесс (например, УСТАНОВКА-ИМПОРТ) демонстрируется на нескольких уроках. Каждый урок содержит видео. Видео показывают небольшую часть рабочего процесса и демонстрируют отдельные концепции того, как эти рабочие процессы соединяют приложения Kolibri.
Основные задачи
Создайте целевую страницу с учебным пособием, которая поможет пользователям решить, какой рабочий процесс лучше всего соответствует их потребностям. Эта целевая страница будет размещена на платформе Read the Docs.
Создавайте индивидуальные уроки по компонентам каждого рабочего процесса и дополняйте сложные уроки упражнениями.
Создавайте интерактивные видеоролики для каждого рабочего процесса.
Инструменты проекта
Работа будет осуществляться с использованием программного обеспечения для скринкастинга. У меня есть опыт работы с Camtasia, но я также работал с менее дорогим и бесплатным программным обеспечением. Пример видео, ссылка на который приведена здесь ( https://youtu.be/DkMP_VdGslU ), был создан с помощью Flashback компанией Blueberry Software, на которую у меня сейчас есть лицензия. Я создам субтитры с помощью Youtube. Страницы учебных пособий будут размещены на сайте Kolibri Read the Docs. Черновой вариант будет завершен в Документах Google, и я могу помочь с преобразованием текстовых файлов в Markdown или reStructuredText для конечного продукта.
График
Этот проект будет следовать руководящим принципам долгосрочного проекта (всего 26 недель, с 02.09.2019 по 28.02.2020). Я буду тратить около 10 часов в неделю на достижение целей, изложенных ниже. Помимо этих целей, я буду в это время принимать участие в менторских встречах и общении по мере необходимости. Я буду работать с наставниками, чтобы определить лучшее время для этого. Временная шкала обычно разбита на четырехнедельные периоды, в течение которых я буду создавать несколько видеороликов, страниц с обучающими материалами и упражнениями.
Недели первая и вторая
Цели:
- Настройте личное устройство с любыми веб-сайтами или учетными записями, необходимыми для доступа к информации.
- Начните разрабатывать структуру и более подробный каркас целевой страницы.
- Обсудите с наставниками стиль видеороликов, а также разработайте шаблон начального экрана видео, любую музыку-вставку для заглавного и конечного экранов, а также дополнительную информацию, которая должна быть включена.
- Просмотрите текущую документацию и ее структуру, чтобы извлечь ссылки для использования в дополнительных ресурсах и руководствах.
Недели с третьей по шестую (уровень 1 – руководства для начинающих)
Цели:
- Разработайте исходное содержание и уроки для рабочего процесса УСТАНОВКА-ИМПОРТ/Уровень 1. Создайте видео о процессах загрузки, установки, настройки и импорта. Поскольку функции INSTALL-IMPORT являются основой для многих других рабочих процессов и наиболее часто используются, большая часть времени будет посвящена доработке этих руководств и уроков.
- Сосредоточьтесь на типах местоположений ИМПОРТ и разработайте графику, которая покажет пользователю, где он может получить контент (общедоступные каналы, существующие в Kolibri Studio) для целевой страницы.
- Разработка дополнительных видеороликов и контента для расширений УСТАНОВКА-ИМПОРТ (канал ОБНОВЛЕНИЕ). Эти расширения также могут быть в виде дополнительных ресурсов или ссылок на существующую документацию.
- Работа над субтитрами для любых видео.
- «Протестируйте» видеоролики и запросите отзывы у любых доступных ресурсов относительно удобства использования. Это будет включать в себя пересмотр шаблона для видео и укрепление шаблона для будущих видео.
Недели с седьмой по десятую (уровень 2 – загрузка контента)
Цели:
- Сосредоточьтесь на уроках и видеороликах о рабочих процессах для Studio Uploader.
- Полная документация и уроки по ЗАГРУЗКЕ-ПУБЛИКАЦИИ-ИМПОРТУ.
- Разработайте субтитры для любых видео.
Недели с одиннадцатой по четырнадцатую (Уровень 3 — «Ремиксер» контента и редактор)
Цели:
- Сосредоточьтесь на следующих рабочих процессах и создайте материалы учебных пособий/уроков: ЗАГРУЗКА-РЕДАКТИРОВАНИЕ-ПУБЛИКУ-ОБНОВЛЕНИЕ и РЕДАКТИРОВАНИЕ-ПУБЛИКАЦИЯ-ОБНОВЛЕНИЕ.
- Разработаем любые субтитры для видео.
Недели с пятнадцати по восемнадцать
Цели:
- Как выяснилось в ходе моего исследования этого предложения, рабочие процессы с участием Ricecooker имеют более низкий приоритет (тип CHEFDEV). В зависимости от времени и графика я мог бы использовать это время для создания руководства высокого уровня, которое ссылается на существующую документацию по Ricecooker.
Недели с девятнадцатой по двадцать вторую
Цели:
- На данный момент оцените любые пробелы и протестируйте текущий ход всех учебных пособий.
- Поработайте над окончательной доработкой целевой страницы и начните связывать видео вместе.
- Работайте над преобразованием черновиков страниц, созданных в Документах Google, в Markdown или reStructuredText, как обсуждалось с наставниками.
Недели с двадцать третьей по двадцать пятую
Цели:
- В зависимости от времени завершите окончательную работу над продвинутыми руководствами с низким приоритетом.
- В последнюю минуту прочтите редактирование страницы документации, тестирование файлов, проверку грамматики/орфографии.
- Контроль качества любых ссылок в видео или на других страницах.
Неделя двадцать шестая
Последняя неделя для долгосрочных проектов. Я буду работать с наставниками, чтобы подвести итоги проекта и завершить всю необходимую документацию Google.
Компоненты учебника
Целевая страница руководства
Пользователи получат доступ к целевой странице учебных пособий на сайте Kolibri Read the Docs, где будет представлен краткий обзор различных учебных пособий, предлагаемых для рабочих процессов с контентом. Цель этой страницы — дать краткий обзор экосистемы Kolibri, а также предоставить графическое представление различных рабочих процессов. Это дает пользователю возможность просматривать тип рабочего процесса, который соответствует его потребностям как технически, так и для учебной программы его организации. Пользователи будут лучше понимать возможности, доступные им в Kolibri и Kolibri Studio.
Страницы учебников и уроков
На каждой домашней странице учебника содержится введение в учебник (состоящий из нескольких уроков), а также некоторые цели пользователя. Учебники иллюстрируют весь рабочий процесс и состоят из отдельных уроков. К каждому уроку будет видео. Видео будут охватывать отдельную часть общей концепции. Каждый урок будет храниться на отдельной странице родительской страницы рабочего процесса обучения. На страницах уроков будут кнопки, которые позволят пользователю перейти к предыдущему или следующему уроку в рамках учебника. Очень сложные концепции могут включать в себя практические действия.
Видео и структура
Видео обрисуют единую концепцию. Видео укажет направление при выполнении этого действия на экране. Пример видео можно найти здесь: https://youtu.be/DkMP_VdGslU . В этом примере видеоролика показано, как использовать мастер настройки.
В видео используются выноски и выделенный курсор, которые помогают пользователю пройти этапы реализации этой единой концепции. Видео будут размещены на Youtube. Если видео размещено на Youtube, субтитры будут созданы автоматически. Затем я отредактирую подписи с точки зрения орфографии, грамматики и пунктуации. Эти подписи затем можно экспортировать для перевода в Amara или другой инструмент перевода.
Видео будут иметь единый титульный экран, который я планирую обсудить с наставниками в первые пару недель. Я также буду использовать единый стиль выносок (стрелки, выделение курсором, прямоугольники), который будет решен вместе с наставниками в первые пару недель.
Примеры структур
Самый простой рабочий процесс УСТАНОВКА-ИМПОРТ представляет собой целое руководство. В этом руководстве есть два потенциальных урока с видео:
- Загрузка, установка и настройка Kolibri Facility
- Импорт контента в Kolibri Studio. Обратите внимание, что это видео будет ссылаться на другие рабочие процессы.
Более продвинутое руководство требует нескольких подуроков с несколькими видео. Рабочий процесс ЗАГРУЗКА-РЕДАКТИРОВАНИЕ-ПУБЛИКАЦИЯ-ОБНОВЛЕНИЕ соответствует приведенной ниже структуре.
Урок 1. Загрузка контента и создание каналов в Kolibri Studio
Цели пользователя: В конце этого урока вы узнаете, как выполнить следующие действия:
- Создавайте каналы в Kolibri Studio для использования в Kolibri. Вы узнаете, как использовать секретные токены вашего канала для импорта вашего канала контента в Колибри.
- Создайте канал, импортировав контент из существующих общедоступных каналов в библиотеке Studio.
- Создайте канал, загрузив контент со своего компьютера.
Видео подуроков:
- Подурок 1 – Создайте свои собственные каналы в Kolibri Studio и импортируйте контент из существующих общедоступных каналов (Khan Academy, PHET и т. д.): Видео 1 – Публичные каналы контента (просмотр ПУБЛИЧНЫХ каналов в Kolibri Studio) Видео 2 – Создание канала Видео 3 – Импорт контента из существующих каналов Видео 4 – Публикация вашего канала и получение секретного токена Видео 5 – Импорт вашего канала в Kolibri с использованием секретного токена
- Подурок 2. Загрузка канала контента «Мои документы»: Видео 1. Загрузка файлов из «Моих документов». Видео 2. Создание собственных упражнений.
Урок 2 – Расширенное редактирование каналов в Kolibri Studio
Цели пользователя: В конце этого урока вы узнаете, как выполнить следующие действия:
- Редактируйте каналы контента в Kolibri Studio
- Управление каналами контента в Kolibri Studio
Видео подуроков:
- Подурок 1. Редактирование контента путем добавления упражнений, реорганизации структуры папок и параметров совместной работы (1 видео)
- Подурок 2 – Использование других функций, таких как удаление/перемещение контента (1 видео)
Урок 3. Публикация каналов Kolibri Studio для использования в Kolibri и обновление каналов
Цели пользователя: В конце этого урока вы узнаете, как выполнить следующие действия:
- Опубликуйте канал в Kolibri Studio и повторите публикацию после добавления нового контента.
- Обновить канал
- Получите токен канала для импорта в Kolibri (по ссылке на предыдущее видео в уроке 1, в котором рассказывается об этом действии)
Видео подуроков:
Подурок 1. Публикация обновлений на канале
Видео 1: Перепубликация канала Видео 2: Обновление канала на Колибри после добавления дополнительного контента